# Starshipit Support Center - Full Documentation Snapshot
> Full public documentation snapshot for AI tools. This file contains the current public help center corpus and excludes internal-only articles.
- [Documentation index](https://support.starshipit.com/llms.txt)
---
# What is Starshipit?
URL: https://support.starshipit.com/articles/6855175282575-what-is-starshipit
Canonical: https://support.starshipit.com/articles/6855175282575-what-is-starshipit
Markdown: https://support.starshipit.com/articles/6855175282575-what-is-starshipit.md
Updated: 2026-05-06
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Learn about Starshipit's shipping and fulfillment platform. Discover how to automate your fulfillment, give customers checkout options, create branded tracking, and save on shipping costs.
Welcome to Starshipit! Whether you've just opened a new online store or manage an international operation shipping thousands of orders per month, you'll find everything you need to know on this page.
The best place to start is with a [30-day free trial](https://app.starshipit.com/Dashboard/Wizard.aspx) of Starshipit, following this [initial set-up guide](/articles/getting-started/intro-to-starshipit/how-to-set-up-starshipit). This guide runs you through everything you need to do to set up Starshipit, integrate your couriers and platforms, and print your first shipping label.
If you’re currently using another shipping solution but would like to switch to Starshipit to save on shipping costs and access features like our rules engine and branded returns portal, [book an appointment](https://starshipit.com/book-an-appointment) to chat with one of our in-house shipping experts. They love to talk shipping!
## Demo video
{{video:youtube:KcUX3medqK4}}
Starshipit is the best practice shipping and fulfilment platform that helps retailers save time and deliver great shipping experiences.
We’ve got seamless integrations with all major eCommerce platforms (like [Shopify](https://starshipit.com/partner/shopify)) and couriers (like [Australia Post](https://starshipit.com/partner/australia-post), [DHL](https://starshipit.com/partner/dhl-express), [FedEx](https://starshipit.com/partner/fedex-express), [Aramex](https://starshipit.com/partner/aramex) and more), which allows you to hit the ground running. You can also use our powerful API to integrate your unique tech stack with Starshipit.
Starshipit streamlines every step of the fulfilment process, reducing handling time, minimising human error and improving the customer delivery experience. We’ve also got free onboarding, training and support for every customer, regardless of size, which helps get you up and running with Starshipit from day one.
## Key features
### Automate your fulfilment
Shipping automation is the most effective way to deliver great shipping experiences. Use powerful fulfilment automation software to reduce handling time, and create packing slips, shipping manifests and customs documentation – all from one dashboard. Get more orders out, faster.
[Learn more about fulfilment automation | Starshipit](https://starshipit.com/fulfilment-automation)
### Give customers a choice at checkout
Increase conversions at checkout and keep customers coming back. Enable multiple delivery options for customers, display accurate transit times and set up automation to account for variations in your shipping costs based on destination, weight, or delivery timeframes.
[Learn more about choice at checkout | Starshipit](https://starshipit.com/choice-at-checkout)
### Create branded tracking pages and notifications
Keep customers in the loop with branded updates. When customers are left in the dark about their orders, help desk queries spike. Our branded tracking pages and email and SMS notifications keep customers informed at every stage of the shipping process.
[Learn more about branded tracking and notifications | Starshipit](https://starshipit.com/branded-tracking-and-notifications)
### Customise your own branded returns portal
Say goodbye to complicated returns and deliver a great returns experience. Create a branded returns portal that empowers customers to generate their own return shipping labels and more. Then, customise notifications for each stage of the returns journey.
[Learn more about branded returns | Starshipit](https://starshipit.com/branded-returns)
### Save on shipping costs
We’re not here to make money on [shipping rates](https://starshipit.com/blog-content/shipping-costs-calculating-the-actual-cost-to-ship-a-package), we’re all about shipping technology. That's why we don’t clip the ticket on your shipments.
There are two options with Starshipit: You can access discounted shipping rates or bring your own rates (with no penalties). If you don’t have a courier account yet, we can set you up in no time with plug-and-play couriers which charge directly to your credit card.
### Free shipping expert support on every plan
Starshipit includes comprehensive onboarding, training and support with every plan, regardless of business size. This means you’ll always have access to our team of shipping experts, who are standing by via phone and email to answer your questions.
## Pricing plans
Starshipit has a variety of pricing plans to suit businesses of every age and stage. Whether you’re just starting out with your first orders or shipping thousands of parcels a week, our plans are flexible.
We’re also focused on shipping technology, not clipping the ticket on rates, so we’ll help you find a courier that works for you, or you can bring your own pre-negotiated shipping rates with no penalty or fee.
* [View our pricing plans](https://starshipit.com/pricing)
* [Start a 30-day free trial](https://app.starshipit.com/Dashboard/Wizard.aspx)
## Need help?
If you're switching from another shipping solution or need guidance on getting started, [book an appointment](https://starshipit.com/book-an-appointment) with our shipping experts to discuss your specific requirements.
---
# Set up your Starshipit account
URL: https://support.starshipit.com/articles/360001118236-set-up-your-starshipit-account
Canonical: https://support.starshipit.com/articles/360001118236-set-up-your-starshipit-account
Markdown: https://support.starshipit.com/articles/360001118236-set-up-your-starshipit-account.md
Updated: 2026-05-06
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Step-by-step guide to setting up Starshipit.
Get started with the basics in Starshipit using our step-by-step guide. Once you're comfortable, optimise your shipping with [our more advanced features](/articles/getting-started/intro-to-starshipit/optimising-your-account).
## How Starshipit works
## Getting started basics
Follow the key steps below to set up Starshipit.
### 1. Set your pickup address for orders
Enter your warehouse, dispatch or company address and contact details for courier collections. These details may be printed on labels depending on your courier and label format.
1. Go to **Settings**.
2. Select **Pickup Address**.
3. Enter your pickup address for collections.
If you use a PO Box address, make sure you [set up rules](/articles/notifications-branded-tracking-rules-child-accounts/business-rules/how-to-manage-orders-going-to-po-boxes) to ensure you don't accidentally send the order with a carrier that doesn't support PO Boxes.
4. Click **Save**.
### 2. Integrate your couriers
To start shipping, you can integrate one or more of your couriers or use our plain label option. You can do this through the Getting Started guide in the Starshipit app or follow step-by-step instructions for your specific courier.
1. [Getting Started – Starshipit app](https://app2.starshipit.com/onboarding)
2. [Find your courier guide](/categories/couriers)
3. [Set up plain labels](/articles/couriers/plain-label/how-to-use-plain-labels)
### 3. Integrate your platforms
Integrate your eCommerce, WMS or IMS, or accounting platform with Starshipit. Choose from a list of 40+ platforms that integrate directly with Starshipit.
* [Find your platform guide](https://support.starshipit.com/hc/en-us/sections/360000208895-eCommerce-platforms)
You can automatically import sales orders directly from your chosen platform or upload orders via a CSV file. You can also build your own integration using our API.
* [Upload orders via CSV](/categories/integrations)
* [Build your own integration with our API](/developers)
If you work with a platform that we do not integrate with yet, you can also use Zapier as a connector between the two platforms.
* [Set up Zapier](/articles/integrations/accounting-other-platforms/zapier-integration)
### 4. Choose how labels should print and print your first label
By default, Starshipit downloads labels as PDFs. For automatic printing, set up the Desktop App on Windows or Mac, choose that machine for each document type in Starshipit, then map each document type to a physical printer in the Desktop App.
[Understand the printing routes and complete the recommended setup](/articles/90200000000155-understand-how-starshipit-printing-works).
{{video:youtube:_q6N-G_3w9M}}
* [Learn all the different ways you can print labels in Starshipit](/articles/printing-labels-packing-slips/printing/about-printing-and-labels)
## Next steps
You’ve set up the essentials - nice work!
Now, take things to the next level and make sure your account is running at its best. Learn how to get the most out of Starshipit, fine-tune your setup, and unlock time-saving features that help your business scale.
👉 [**Watch: Optimise your Starshipit setup**](/articles/getting-started/intro-to-starshipit/optimising-your-account)
---
# Optimise your Starshipit account
URL: https://support.starshipit.com/articles/8023014462991-optimise-your-starshipit-account
Canonical: https://support.starshipit.com/articles/8023014462991-optimise-your-starshipit-account
Markdown: https://support.starshipit.com/articles/8023014462991-optimise-your-starshipit-account.md
Updated: 2026-05-06
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Learn how to optimise your Starshipit account with packaging types, automation rules, custom notifications, and checkout rates. Follow this checklist to streamline your shipping workflow.
By this stage, you should already have your **eCommerce platform and courier accounts connected** and your orders importing automatically into Starshipit.
Now you’re ready to **optimise and streamline your shipping** - from adding packaging types and automation rules to custom notifications and checkout rates.
## Watch: Optimise your Starshipit setup
Watch this short video to see how to optimise your account, test your workflow, and set your team up for success. Then, follow the steps below to complete your setup and continue optimising your account.
{{video:youtube:MFZ_PsqD9gw}}
## Optimise your account checklist
### 1. Check Your Integrations
Before getting started, double-check that your **eCommerce platform** and **courier accounts** are connected, tested, and ready.
By now, your orders should already be importing automatically into Starshipit.
If you haven’t completed this step yet, follow the [in-app setup wizard](https://app2.starshipit.com/onboarding) or the [getting started guide.](/articles/getting-started/intro-to-starshipit/how-to-set-up-starshipit)
### 2. Add Your Packaging Types
Once your orders are imported, head to **Settings → Packaging** and add the packaging you use most often (boxes, padded mailers, satchels, etc).
Here’s what you can do:
* Add your **box sizes and weights**
* Set a **default package** for each courier
* Create different packages for products with unique shapes or weights (e.g. wine, batteries, skincare)
This helps allocate the right packaging automatically — saving time and reducing errors.
[Learn more about package setup →](/articles/orders-manifests-reports/orders/set-up-packages-and-import-weights-and-dimensions)
### 3. Set Your Shipping Rules
{{video:youtube:f_vWY2PMTL4}}
Next, it’s time to set your shipping rules. Starshipit can apply business rules when you import your orders. A rule can include multiple conditions and one action.
Go to **Settings → Rules** and start with something simple, like:
> **“All orders where destination is not AU → DHL Itl”**
Rules help automate courier selection and cut down manual work.
**Popular examples:**
* **Assigning Shipping Methods Based on Destination:** This rule allows you to automatically assign different shipping methods based on the destination of the order. For example, you might want to use a specific courier for all orders going to a certain country or region.
* **Setting Up a Default HS Code:** If most of your products fall under the same HS Code, setting up a rule to assign a default HS Code can save you time. This rule will automatically apply the default HS Code to any items where the HS Code field is blank.
* **Assigning Shipping Methods Based on Weight or Order Value:** These rules can help you automatically select the most cost-effective shipping method based on the weight of the order or the total order value. For example, you might want to use a cheaper shipping method for lighter packages or offer free shipping for orders over a certain value.
[Learn more about rules →](/articles/notifications-branded-tracking-rules-child-accounts/business-rules/rules-overview)
### 4. Test Your Printer Setup
Now that your internal settings are sorted, test your printer setup.
👉 If you’ve just added packaging or rules, **remove and re-import orders** first to make sure your changes apply correctly.
Follow the recommended printing setup for Mac or Windows. It explains both settings you need: Starshipit chooses the Desktop App machine, then that machine chooses the physical printer.
[Set up and test printing →](/articles/90200000000155-understand-how-starshipit-printing-works)
Then test by printing a few labels.
### 5. Test with a Few Orders
Run a few live orders through Starshipit to confirm everything’s working:
* The **right courier** is applied automatically
* **Labels print correctly**
* **Tracking info** writes back to your store
If something’s not right, check your **account settings**, **rules**, or **integration setup**.
Once your basics are in place, explore a few extra features to make life even easier:
## Customer experience and notifications
### Checkout Rates
Display shipping costs directly at checkout — either **live courier rates** or **flat-rate options**.
You can also add **margins** to control costs and set rates by **destination** or **weight**.
[Learn about checkout rates](/articles/rates-at-checkout/set-up-guides/rules-for-checkout-rates) [→](/articles/rates-at-checkout/set-up-guides/rules-for-checkout-rates)
### Shipping Notifications
Cut down on “Where’s my order?” queries with **automated notifications**.
Go to **Settings → Customer Notifications** to:
* [Enable and configure the branded tracking page](/articles/notifications-branded-tracking-rules-child-accounts/branded-tracking/enable-and-configure-the-branded-tracking-page)
* [Customise outbound email notifications](/articles/notifications-branded-tracking-rules-child-accounts/notifications/set-up-email-notifications)
### Validate Incorrect Shipping Addresses
{{video:youtube:qeUdvcDhlx0}}
Starshipit automatically detects invalid addresses so you can fix them instantly — even if customers enter the wrong details.
[Learn about address validation →](/articles/orders-manifests-reports/orders/validating-shipping-addresses)
## Operations and integration
### Choose Write-Back Options
Starshipit automatically sends tracking details and order statuses back to your platform.
Default behaviour is write-back **when a label is printed**, but you can change this to trigger **on manifest** or **dispatch**.
[Learn more about write-back →](/articles/orders-manifests-reports/faqs/does-starshipit-automatically-update-my-integrated-ecommerce-platform)
### Print Your Packing Slips
Choose to print packing slips:
* Directly from Starshipit
* From your integrated platform (e.g. Shopify)
Or batch-print labels and packing slips together - go to **Settings → Packing Slip** to configure.
[Learn more about packing slips and summaries →](/categories/configure-shipping-workflows/packing-documents)
### Configure International Shipping Options
If you ship internationally, go to **Settings → Options** to set:
* Currency
* Timezone
* Default item description
* HS Code
* Country of manufacture
* Imperial or metric measurements
## Scale and advanced setup
### Add Users to Your Account
Invite users to your Starshipit account and assign them specific permissions, allowing you to streamline your shipping operations across your team and maintain data security.
[Managing users →](/articles/settings-billing-security/account-settings/add-users-to-your-starshipit-account)
### Multi-Location, 3PL & WMS Setups
Starshipit supports complex setups, including:
* Multi-location
* Multi-brand
* Drop shipping
* 3PL
* Warehouse or inventory systems
Use **child accounts** linked to a **parent account** to manage all of them in one place.
[Learn more →](/articles/360001188356)
### Explore Advanced Features
* [**Set up warehouse packing stations**](/articles/8439609255183-set-up-warehouse-packing-stations) for efficient picking, packing, scanning, and printing
* [**Packing validation**](/articles/getting-started/barcode-scanning/validate-items-using-barcode-scanning) to reduce picking errors
* [**Product catalogue**](/articles/integrations/product-catalogue/product-catalogue) to manage product data and HS codes consistently
---
# Configure your Starshipit dashboard (UI 2.0)
URL: https://support.starshipit.com/articles/8252689711887-configure-your-starshipit-dashboard-ui-20
Canonical: https://support.starshipit.com/articles/8252689711887-configure-your-starshipit-dashboard-ui-20
Markdown: https://support.starshipit.com/articles/8252689711887-configure-your-starshipit-dashboard-ui-20.md
Updated: 2026-05-06
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Configure your Starshipit dashboard, columns, views, and shortcuts in UI 2.0.
## Choose which columns to display
You can choose which columns are displayed in the orders grid. To access the list of columns:
1. Open the column options drop-down menu in the top right of the orders grid.
2. Under **Column Options**, click the check box next to the columns you wish to display in the orders grid.
3. Once you've selected (and deselected) the columns you want to display, click **Apply** at the bottom of the drop-down menu.
Here are the columns you can choose from:
| Column | Description |
|--------|-------------|
| Bin Location | The bin locations of the items in the order. |
| Carrier & Product | The carrier responsible for shipping the order and the carrier product chosen. |
| Company Name | The receiver's company name. |
| Country | The destination country. |
| Customer | The customer's name. |
| Description | A brief description of the ordered items. |
| Item QTY | The total number of items ordered. |
| Item Total | The total value of the items ordered excluding shipping (available in the new tab only). |
| Item(s) | The individual items included in the order. |
| Method | The method or mode of shipping or delivery chosen for the order. |
| Notes | Any notes for the order. |
| Packaging | Information about the packaging details. |
| Print Button | A button to initiate the printing of a shipping label. |
| Reference | The reference number for the order. |
| Shipping Paid | The value of the shipping paid by the customer at checkout. |
| SKU(S) | SKUs for items ordered and their quantities. |
| Source | The source or origin of the order. |
| State | The destination state or province within the destination country. |
| Tags | Any labels or tags associated with the order for organisational purposes. |
| Weight | The weight of the shipment. |
## Expanded grid view
Use the expanded grid view to display each item, SKU, and bin location on a new line, allowing for easy viewing of up to 5 items per order.
To enable the expanded grid view:
1. Open the column options menu in the top right of the orders grid.
2. Under **Grid View**, select **Expanded.**
3. Click **Apply.**
## Hotkeys and shortcuts
| Action | Shortcut |
|--------|----------|
| Select multiple orders | Click the first order, hold **Shift** and click the last order |
| Close modal without saving | Press **ESC** |
| Save and close modal | Press **Enter** or **Return** |
## Edit order information from the orders grid
You can make edits to orders directly from the orders grid, meaning you don't need to open each order individually.
You can edit the following from within the Orders grid:
* Customer/receiver address
* Item(s) and item information
* SKU(s)
* Carrier product options (i.e. ATL/Signature required)
* Packaging dimensions
:::tip
To edit the receiver address for an order, click the **edit icon** in the Customer column and update as required, then click **Save**.
:::
## Creating and accessing views
You can save customised views of orders with different filters to easily access them.
#### To create and save a new view
1. From the orders grid, click the **Filter orders** field on the top left.
2. Select an option to filter by, or select multiple options.
For example, "Carrier: Australia Post" and "State: NSW".
3. The filters will be applied once clicked.
4. To save these filters as a view, click **Save as a view** next to the **Filter orders** drop-down menu.
5. Enter a unique name for the view then click **Save**.
If there's an option you’d like to filter by but it's not available in the preset, you can use tags instead.
1. Navigate to **Settings** > **Tags**.
2. Click **Add new** to create a tag to filter by.
3. After adding your tags, navigate to **Rules**.
4. Click **Add a new rule**.
For this example, if the order value is over $500, assign tag High Value.
5. Now, filter your order grid for orders with the tag High Value and save this so you can easily view your high value orders.
#### To access a saved view
1. From the orders grid, click on the **Select view** drop-down menu on the top left.
2. Select a view by clicking on its name.
---
# Switch between Classic UI and UI 2.0
URL: https://support.starshipit.com/articles/4928214852239-switch-between-classic-ui-and-ui-20
Canonical: https://support.starshipit.com/articles/4928214852239-switch-between-classic-ui-and-ui-20
Markdown: https://support.starshipit.com/articles/4928214852239-switch-between-classic-ui-and-ui-20.md
Updated: 2026-05-06
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Switch between Classic UI and UI 2.0 in Starshipit.
## Why we created UI 2.0
UI 2.0 is the next evolution of Starshipit, built on a modern foundation that enables:
- **Faster updates**: Our teams can deliver new features more frequently
- **Improved accessibility**: Better experience for all users
- **Enhanced performance**: More responsive while offering more functionality
- **Your feedback**: Incorporating the improvements you've asked for
## Moving to UI 2.0
If you'd like to check out the new platform, we've made this super easy.
1. Log into [Starshipit](https://app.starshipit.com/) with your usual Starshipit credentials.
2. In the bottom left of the navigation menu, you'll see a toggle to switch to **UI 2.0**.
3. Selecting this will redirect you to our new interface.
## Moving to Classic UI
If at any point you'd like to return back to the original application, you can change back by:
1. Log into [Starshipit](https://app2.starshipit.com/) with your usual Starshipit credentials.
2. In the bottom left of the navigation menu, you'll see a toggle to switch to Classic UI.
3. Select **Switch to classic UI.**
4. You will be redirected back to Starshipit Classic.
## Print Application
The current Starshipit Desktop App supports printing from Starshipit on Windows and macOS. You do not need a different app for each web interface.
If you use automatic desktop printing, confirm the account's printing settings route each document type to the expected Desktop App machine. On that computer, confirm the Desktop App maps the same document type to the correct physical printer.
[Understand the printing routes and set up the Desktop App](/articles/90200000000155-understand-how-starshipit-printing-works).
## Major Updates
UI 2.0 feels like an upgraded version of a platform you're already comfortable with. Here's what's new:
| Feature | What's new |
|---------|------------|
| **Edits from grid** | Make quick changes directly from the orders grid: update package type, address details, items, courier, and service code. |
| **Order Grid** | • See full destination details: company name, estimated shipping price, package used, shipping paid, item quantity, notes, bin location • **Customisable columns**: Hide, display, or rearrange. Preferences are saved • **Grid View Options**: Click the cog icon to choose Compact View (single line) or Expanded View (extended row) |
| **Order Details** | New sections when opening orders: • **Sender/Receiver**: Addresses on the right side (click pencil to edit) • **Shipping Breakdown**: Dynamic quote breakdown from the courier • **Package Views**: New "Single Package View" for managing multiple packages • **Items**: View Bin Locations, Mid Codes, Brands (use [product catalogue](/articles/integrations/product-catalogue/product-catalogue) for auto-population) • **Additional Details**: Insurance value and reference data • **Tax Details**: Receiver tax info for international orders • **Customs Details**: Incoterms, attached documents for international orders • **Order Notes**: Add processing notes (e.g., "add a gift note") |
| **Analytics** | [Shipping analytics](/articles/orders-manifests-reports/shipping-analytics/shipping-analytics) to analyse shipping metrics, improve delivery experience, and make data-driven decisions. Track if carriers are meeting delivery KPIs. |
| **Tags** | Add [tags](/articles/orders-manifests-reports/orders/tags) to orders for easier organisation and management. |
| **Workflows** | Quick Print is now **Workflows**. • New terminology: "Print order" → "Scan and print", "Open to order details" → "Scan and open" • [Packing validation](/articles/getting-started/barcode-scanning/validate-items-using-barcode-scanning): Scan barcodes to verify items belong in the order • [Scan to select packaging/carriers](/articles/getting-started/barcode-scanning/select-packaging-and-carrier-products-using-barcode-scanning): Update package type, courier, and print • [Search/print from child accounts](/articles/getting-started/barcode-scanning/scan-to-open-and-print): Access orders across linked accounts • [Reprint orders](/articles/getting-started/barcode-scanning/scan-to-open-and-print): Easily reprint previously printed labels |
| **Suggested Merges** | [Suggested Merges](/articles/orders-manifests-reports/faqs/suggested-merges) recommends orders to combine when they share the same destination. Consolidate shipments and cut costs. *UI 2.0 exclusive.* |
| **Scheduled Reports** | [Scheduled Reporting](/articles/orders-manifests-reports/reports/scheduled-reporting): Set up automated daily or weekly report deliveries for consistent account overviews. |
| **Order Navigation** | • Forward/back buttons in the top right of order details • "Print and next" button: After printing, immediately shows the next order |
## Minor Updates
| Feature | What's changed |
|---------|----------------|
| **Search** | Moved to the top right. Search by customer name, order number, or tracking number from anywhere in the app. |
| **Account Details** | Plan management, billing, logout, and support are now in the user dropdown. Access via the blue arrow next to your username (top right). |
| **Actions Menu** | Displays at the top when you select orders from the grid. Includes familiar actions plus new ones like add/remove tags. |
| **Individual Order Actions** | Two menus when viewing orders: • **Print** menu: All printing options • **Actions** menu: Resend, Clone, Book Pickups, etc. |
| **Validating Addresses** | • **Bulk**: Select **Check Addresses** (top right) to see only invalid addresses, then bulk or individual update • **Single**: Click pencil next to address, then "check address" in bottom right |
| **Switching Accounts** | Click username (top right) → **Switch Accounts**. Includes search filter for users with many child accounts. |
| **Booking Pickups** | Use the actions menu. Pickup history has moved to its own page in the left navigation. |
| **Packed Orders** | Printing a packing slip automatically adds the "packing slip printed" tag for easy identification. |
## Share your feedback
We welcome your thoughts on UI 2.0. Leave feedback on our [dedicated UI 2.0 product board](https://starshipit.canny.io/ui-20-feedback) or [contact our support team](https://help.starshipit.com) for assistance.
---
# Set up warehouse packing stations
URL: https://support.starshipit.com/articles/8439609255183-set-up-warehouse-packing-stations
Canonical: https://support.starshipit.com/articles/8439609255183-set-up-warehouse-packing-stations
Markdown: https://support.starshipit.com/articles/8439609255183-set-up-warehouse-packing-stations.md
Updated: 2026-05-06
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Set up computers, scanners, printers, and packing materials for warehouse fulfilment.
Set up a warehouse packing station for browser-based Packing Validation or the separate Starshipit Pick & Pack mobile app.
## What is a pick and pack process?
Picking and packing is the process of selecting and packaging products in your warehouse. This involves 'picking' the right products from your inventory and 'packing' them for shipment. Pick and pack is one of the most expensive and time-consuming activities in fulfilment.
Generally you will use a picking list, which includes the items for a number of orders. Once you've picked the items, you’ll take them to a packing station where you can pack them into their individual orders.
## What is a pick and pack station?
These are dedicated areas in your warehouse where items are picked and packed for shipment. The setup should be ergonomic, well-organised, and integrated with your order processing system.
Here’s what you should keep in mind:
* **Shelving and bins:** Organise items for easy access.
* **Packing materials:** Boxes, bubble wrap, tape, and labels.
* **Computers:** For accessing Starshipit.
* **Barcode scanners:** To use with Starshipit’s Workflows.
* **Printers:** For shipping labels, invoices, packing summaries and packing slips.
## Configure your workstations
Follow our step-by-step guide on setting up and configuring a packing station, using barcode scanners. This is the optimal way to set up your warehouse with Starshipit if you have two (or more) pick and pack stations.
## How to set up each station to print
For automatic browser printing, install the Desktop App on each Windows or Mac computer that will receive print jobs. Two settings control the result:
1. In the Starshipit website, route each label or document type to the Desktop App machine for that station.
2. In the Desktop App on that machine, map the same label or document type to its physical printer.
Local printer mappings are configured separately on each computer. Test each station from the workflow staff will use before going live.
* [Understand the printing routes and set up each station](/articles/90200000000155-understand-how-starshipit-printing-works)
## Choose a browser or mobile workflow
Starshipit has two separate ways to validate items while packing:
* **Packing Validation in the Starshipit web app:** Use a computer and barcode scanner at a packing station. Configure it under **Settings > Packing Validation**. See [Scan to validate items](/articles/6811966579215).
* **Starshipit Pick & Pack mobile app:** Use the separate mobile add-on on a supported phone or tablet to pick, pack, validate, and print. See [Starshipit Pick & Pack mobile app overview](/articles/14427666806031).
Choose the workflow that matches the device staff will use at the station. They are separate features and have different settings.
## Set up your packing summaries and packing slips
### Packing summaries
A packing summary is a consolidated list of order SKUs, item descriptions and quantities that need to be picked to fulfil a selection of orders. This can be one or several orders. The items on the packing summary will be sorted (by SKU, bin location or item name) so that you can easily locate and bulk pick many items efficiently. Once picked, the items are then brought to a central packing station for packing using packing slips as a reference.
* [Learn how to generate a packing summary](/articles/printing-labels-packing-slips/packing-slips-and-summaries/print-packing-summaries)
### Packing slips
Packing slips help you identify which items need to be packed on a per order basis. You can include information such SKU, item description, quantity, colour, and size on your packing slips.
* [Learn how to configure packing slips](/articles/printing-labels-packing-slips/packing-slips-and-summaries/configure-packing-slips)
## Set up your packages in Starshipit
Set up your packages and carrier products in Starshipit if you haven't already done so and create barcode sheets with a barcode for each package.
That way, when it comes time to pick and pack, you can simply scan a barcode to select a package.
* [Learn how to set up packages](/articles/orders-manifests-reports/orders/set-up-packages-and-import-weights-and-dimensions)
* [Scan to select packaging](/articles/getting-started/barcode-scanning/select-packaging-and-carrier-products-using-barcode-scanning)
## Optimal picking and packing workflow (with barcode scanner)
Below we’ve outlined a best-practice approach for picking and packing using Starshipit, with a barcode scanner. This is just one workflow – you can configure Starshipit in a way that works for you.
For example, you may wish to print shipping labels along with your packing summaries. Or, you may not require packing validation.
### Picking your items with Starshipit
Start by printing out your packing slip (and packing summary if packing multiple orders). Then, collect your items from the warehouse.
### Check your orders with Packing Validation
Now that you’ve collected your items, it’s time to validate the items for each order.
First, head to Workflows in Starshipit and tick Scan to select packaging, carriers, and print labels.
Then, select Packing Validation. Scan the barcode on the packing slip. Now scan the barcode or enter the SKU of each item to verify it has been packed.
Once you've marked your packing as complete, you will be taken to the order details to select the packaging and print the shipping label.
* [Packing Validation](/articles/getting-started/barcode-scanning/validate-items-using-barcode-scanning)
### Scan to select your packaging
Next, we’ll use our barcode scanner to select packages for our orders and assign carrier products.
Simply scan a barcode for each package on your order, and the correct package will be updated automatically.
* [Scan to select packaging](/articles/getting-started/barcode-scanning/select-packaging-and-carrier-products-using-barcode-scanning)
Note: You can also use shipping rules to assign packages to orders automatically. For example, you could create a rule to assign a package type based on SKU.
* [Learn more about rules](/articles/notifications-branded-tracking-rules-child-accounts/business-rules/rules-overview)
### Print your shipping label
With our packaging selected and our order packed and ready to go, it’s time to print our shipping label. You can either scan to print using a print barcode or simply click Print in the bottom right of the order details screen.
* [Scan to open and print](/articles/getting-started/barcode-scanning/scan-to-open-and-print)
### Attach your shipping label
Now that we’ve printed our label, we can attach it to the package and it's good to go.
---
# Connect your couriers
URL: https://support.starshipit.com/articles/360001709115-connect-your-couriers
Canonical: https://support.starshipit.com/articles/360001709115-connect-your-couriers
Markdown: https://support.starshipit.com/articles/360001709115-connect-your-couriers.md
Updated: 2026-05-06
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Learn how to integrate your couriers.
* This article outlines the basics of courier integration.
* Integration requirements differ between couriers. With some couriers, Starshipit will contact the courier on your behalf to retrieve the required credentials. In other cases, you will need to contact them directly.
## How does Starshipit handle shipping rates?
We don’t clip the ticket on your shipments.
There are two options for rates with Starshipit: You can access discounted shipping rates or bring your own rates (with no penalties).
If you don’t have a courier account yet, we can get you set up in no time with plug-and-play couriers which charge directly to your credit card.
{{video:youtube:z_IxerF8yYI}}
## Start integrating with your couriers
1. Log into Starshipit then navigate to **Settings** > **Couriers**.
2. Click **Add a new courier**.
3. Select the country you are shipping from in the drop-down list.
4. Click on the courier you'd like to integrate with.
5. Depending on the courier you select, you will either be prompted to enter your account details or be given the next steps, e.g. contact the courier directly.
6. If you are prompted to enter your account details, enter it and click **Save**. If you are given next steps, follow the instructions.
7. Check out our support section [here](/categories/couriers) for more information about setting up your specific courier.
---
# Set a default courier service
URL: https://support.starshipit.com/articles/203889659-set-a-default-courier-service
Canonical: https://support.starshipit.com/articles/203889659-set-a-default-courier-service
Markdown: https://support.starshipit.com/articles/203889659-set-a-default-courier-service.md
Updated: 2026-05-06
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Learn how to select your default international and domestic courier service. The default courier service will be applied to any order you import according to the delivery address.
* Learn how to select your default international and domestic courier service.
* The default courier service will be applied to any order you import according to the delivery address.
{{video:youtube:knOze5mwgh8}}
## Select default couriers
1. In your [Starshipit](https://app2.starshipit.com/) account, go to **Settings** > **Couriers**.
2. Choose a default **International courier** and a default **Domestic courier**.
The options in the drop-down menu are populated by the couriers you have integrated with your account.
3. Open the **Settings** for the couriers you've selected, and add your default product codes.
4. Click **Save.**
---
# Set up Allied Express
URL: https://support.starshipit.com/articles/9511600289423-set-up-allied-express
Canonical: https://support.starshipit.com/articles/9511600289423-set-up-allied-express
Markdown: https://support.starshipit.com/articles/9511600289423-set-up-allied-express.md
Updated: 2026-05-06
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Step-by-step guide to setting up Allied Express.
Starshipit integrates with [Allied Express](https://starshipit.com/partner/allied-express-shipping) for domestic shipping within Australia. This guide will walk you through setting up Allied Express as a courier service in Starshipit.
## Before you begin
If you are an existing Allied Express customer, you must first email their [integrations team](mailto:client.integrations@alliedexpress.com.au) and ask for authorisation to use Starshipit.
To set up Allied Express, you will need your:
* Allied Express Account Code
* Account State
You can request these details from your Allied Express account manager.
Reach out to [Starshipit support](https://help.starshipit.com) with your Allied Express Account Code so that we can help you get set up. Once you have confirmation from Starshipit support that your account is set up you can follow the below set up steps.
## How to set up Allied Express
1. In Starshipit, navigate to **Settings** > **Couriers** > **Add a new courier**.
2. Select **Allied Express**.
3. Tick **Enable Allied Express**.
4. Enter your Allied Express Account Code.
5. Enter your Allied Express Account State.
6. Select the type of labels you want to print off (100x150 or A4).
7. Enter product codes for the services you would like to enable:
* PT (AOE Standard Pallet)
* PT2 (AOE Oversized Pallet)
* C (AOE Overnight Express)
* R (AOE Road Express)
* E (AET Executive)
* G (AET GOLD)
* N (AET Normal)
* V (AET VIP)
8. Click **Save**.
9. Click **Test to ensure it works** to verify your credentials are correct.
:::note
Due to technical limitations, we are currently unable to provide a direct tracking URL. Instead, our tracking links will redirect the customer to the Allied Express website where they’ll be able to view the status of their order.
:::
## Cancel orders
You can now cancel Allied Express labels that have been printed in Starshipit.
#### How to cancel an order.
Navigate to Settings > Couriers > Allied Express Settings. Move to the Tools tab. Under Cancel a Shipment, enter the tracking number and the receiver's postcode. Click Cancel to confirm.
## Package types and references
For accurate Allied Express rates, select the package type that matches the freight you are sending. Use a skid or pallet package type for skid freight rather than a carton.
## Configure Allied Express settings
The Allied Express **Settings** tab includes these options:
| Setting | What it controls |
| --- | --- |
| **Enable Allied Express** | Makes Allied Express available for booking shipments. |
| **Account code** | Identifies your Allied Express account. |
| **Label type** | Chooses peel-off 100 x 150 mm labels or three-part A4 labels. |
| **Use Test Endpoints** | Sends requests to Allied Express test services while you are testing. Leave this off for live shipments. |
| **Display SKUs on label** | Adds item SKUs to the printed label. |
| **Book a pickup when creating shipments** | Requests a pickup automatically when a shipment is created. |
In **Product codes**, add each Allied Express service enabled for your account. In **Tools**, you can cancel a shipment using its tracking number and receiver postcode.
---
# Set up Amazon Easy Ship
URL: https://support.starshipit.com/articles/5362489295759-set-up-amazon-easy-ship
Canonical: https://support.starshipit.com/articles/5362489295759-set-up-amazon-easy-ship
Markdown: https://support.starshipit.com/articles/5362489295759-set-up-amazon-easy-ship.md
Updated: 2026-05-06
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Step-by-step guide to setting up Amazon Easy Ship.
* Amazon Easy Ship is Amazon's delivery service that allows your Amazon orders to be picked up from your location by an Amazon-managed logistics service and delivered to your customer’s doorstep. In turn, your customer will get fast, reliable and 100% trackable deliveries.
* Amazon Easy Ship's integration with Starshipit allows you to generate packing slips and shipping labels, send branded tracking notifications and update Amazon with tracking information.
## What you need to get started
Before getting started with Amazon Easy Ship you will need a few things:
* Please make sure you have opted in for Amazon Easy Ship. For information on getting this set up, see [Amazon's guide.](https://sell.amazon.com.au/easy-ship)
* You will need to have your Amazon store integrated into your account. To add Amazon, see [here](/articles/integrations/ecommerce-platforms/amazon-integration).
## How to set up Amazon Easy Ship
To enable Amazon Easy Ship on your Starshipit account:
1. Login to [Starshipit](https://app2.starshipit.com/).
2. Go to **Settings** > **Couriers** > **Add a new courier** > **Amazon Easy Ship**.
3. Tick **Enable Amazon Easy Ship**.
4. Click **Save**.
You will then need to select which Amazon stores you would like to use this integration for.
1. Go to **Settings**> **Integrations** > **Settings** next to your Amazon store.
2. Tick **Use Amazon Easy Ship**.
3. Click **Save**.
You're now ready to ship!
## Amazon Easy Ship Available Products
* Amazon Easy Ship will show as a shipping option for your Amazon Marketplace orders only.
* Amazon Easy Ship is available for domestic shipments within Australia.
* To learn more about Amazon Easy Ship restrictions see [here.](https://sellercentral.amazon.com.au/help/hub/reference/external/G201381980?ref=efph_G201381980_cont_521&locale=en-AU)
* Amazon Easy Ship service will not show a rate in Starshipit.
* When you print a label for Amazon Easy Ship, this will schedule a pickup with Amazon’s shipping partner. Please keep this in mind when printing Amazon Easy Ship orders.
## Configure Amazon Easy Ship settings
After connecting Amazon Easy Ship, review the following linked-store details:
| Setting | What it controls |
| --- | --- |
| **Enable Amazon Easy Ship** | Enables Easy Ship as a courier option. |
| **Use Amazon Easy Ship** (on each Amazon store) | Routes that store's eligible orders through Easy Ship. |
| **Marketplace country** | Identifies the Amazon marketplace for the linked store. |
| **API type** | Shows the API used by the linked Amazon integration. |
| **Integration enabled** | Shows whether the linked Amazon integration is active. |
Use the **Download Easy Ship label** tool to enter an Amazon order ID and download its label. The Amazon store must be linked before the store-level options appear.
---
# Amazon Shipping
URL: https://support.starshipit.com/articles/8359001313935-amazon-shipping
Canonical: https://support.starshipit.com/articles/8359001313935-amazon-shipping
Markdown: https://support.starshipit.com/articles/8359001313935-amazon-shipping.md
Updated: 2026-05-06
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Connect Amazon Shipping to Starshipit and configure its delivery services.
* Before you get started
* Amazon shipping options
* FAQs
* Amazon shipping is a courier service and can be used to deliver orders from any eCommerce platform (you do not need to be selling on Amazon Marketplace to use Amazon shipping).
* This article outlines how to set up Amazon Shipping as a carrier service in Starshipit.
:::warning
Amazon Shipping is currently for the United Kingdom only (UK).
:::
## Before you get started
Before getting started you will need to apply and open and be approved for an Amazon Shipping Account. If you don't already have an account, you can [sign up here on the Amazon Shipping website](https://shipping.amazon.co.uk/).
## How to set up Amazon Shipping
1. Go to **Settings** > **Couriers**.
2. Click **Add a new courier**.
3. Select **United Kingdom** from the dropdown option in the **Shipping From** section.
4. Click **Amazon Shipping**.
5. Select **Enable Amazon Shipping**.
6. Select **UK** for **Amazon Marketplace** and enter your **Shipper ID**.
7. If you are testing the connection, select **Use Sandbox**. Leave it off for live shipments.
8. Click **Authorize**. This redirects you to the Amazon Shipping website to log in.
9. Enter your Amazon Shipping credentials.
10. When prompted, accept the terms and authorise Starshipit for Direct-to-consumer Delivery by clicking **Authorise**.
11. After authorisation, you’ll be redirected back to Starshipit.
12. Click **Save**.
## Amazon Shipping Options
Amazon offers multiple fulfillment services that can be leveraged for your business. These include:
* **Fulfilled by Merchant (FBM)**
FBM is a service where the retailer takes on all responsibilities for fulfilling customer orders. Under this model, Amazon provides a listing space on the marketplace, but you are responsible for all other aspects of the business, including storing inventory, shipping to customers, handling returns, issuing refunds, and providing customer support.
* **Fulfilled by Amazon (FBA)**
FBA is a service where the retailer is only responsible for manufacturing or sourcing the products and driving buyers to your online store. Amazon takes care of picking, packing, shipping, returns and refunds, as well as customer support for all products under this specific service. This is only supported for orders placed on Amazon.
* **Multi-Channel Fulfillment (MCF)**
MCF is a service that allows you to store your inventory at Amazon warehouses and manage order fulfillment across various sales channels. For instance, if you operate a Shopify store and also sell products on Amazon's marketplace, Amazon will handle orders placed on both platforms, streamlining your fulfillment process.
## Amazon Shipping FAQs
**Can I use Amazon Shipping to ship Amazon orders placed via Amazon Marketplace?**
Yes, but even though the order was created in the Amazon Marketplace, Starshipit will treat it as if it was created by an external platform (outside of Amazon).
Note: When the order is treated as coming from an external platform, the services and shipping speed to ensure the delivery promises offered by Amazon Shipping are slightly different, and you may not be entitled to the BuyShipping benefits offered by Amazon.
**Can I use Amazon Shipping to ship international orders?**
Currently, the integration only supports UK domestic Shipments (UK to UK).
**Can I send multiple packages in one shipment?**
This is not currently supported.
**Does Amazon Shipping offer additional services such as Signature required or handling dangerous goods?**
This is not currently supported.
---
# Set up Aramex (MyFastway)
URL: https://support.starshipit.com/articles/204485635-set-up-aramex-myfastway
Canonical: https://support.starshipit.com/articles/204485635-set-up-aramex-myfastway
Markdown: https://support.starshipit.com/articles/204485635-set-up-aramex-myfastway.md
Updated: 2026-09-03
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Step-by-step guide to setting up Aramex (MyFastway).
Set up [Aramex (MyFastway)](https://www.starshipit.com/partner/aramex) in Starshipit for domestic shipping in Australia and New Zealand. Supports label generation, address correction, branded tracking, returns, and notifications.
## How it works
* Integrate your Aramex account using the legacy FastLabel API, or the new MyFastway API.
* If you are unsure which Fastway API you have set up, please check with your Aramex account manager.
## Set up Aramex with MyFastway API
To set up Aramex, you need to generate an API Key, Client ID and Secret.
1. Log into Aramex then go to **Administration** > **API Keys** > **Create Key**.
2. Click **Save**.
3. Copy your **Client ID** and **Secret**.
Once you have your API Key, Client ID and Secret, you can set up Aramex in Starshipit.
1. In Starshipit, navigate to **Settings >** **Couriers**.
2. Click **Add a new courier**, then select **Aramex**.
3. Tick **Enable Aramex** and **Use MyFastway API**.
4. Enter the **Client ID** and **Client Secret** copied from Aramex.
5. Tick **Use Version 2 Quotes API**.
6. If Aramex has confirmed that your account is a reseller account, open the **Advanced** tab and tick **Reseller account**.
7. Click **Save**.
:::important
Only enable **Reseller account** when Aramex has confirmed that account type. This setting lets eligible reseller accounts get rates and print labels through Starshipit.
:::
### Add product codes
To complete the integration between Starshipit and Aramex, you need to add your product codes. You can load all MyFastway product codes by clicking **Add default product codes**.
The available product codes are:
* Package/Parcel = P
* Satchel A2 = A2
* Satchel A3 = A3
* Satchel A4 = A4
* Satchel A5 = A5
* Priority Parcel = P_PRIORITY
* Priority Satchel A2 = A2_PRIORITY
* Priority Satchel A3 = A3_PRIORITY
* Priority Satchel A4 = A4_PRIORITY
* Priority Satchel A5 = A5_PRIORITY
* DL (only available in New Zealand) = DL
* 300g = 300gm
:::note
Priority is only supported in Australia.
:::
## Set up Aramex with FastLabel API
If you're using the legacy FastLabel API, request an [API Key from Aramex](https://api.fastway.org/v7/docs/page/GetAPIKey.html) before you begin.
### Set up Aramex manually
If you know your Aramex API Key you can manually activate and set up FastLabel.
1. In Starshipit, navigate to **Settings** > **Couriers**.
2. Click **Add a new courier**, then select **Aramex**.
3. Tick **Enable Aramex.**
4. Enter your Aramex **API Key**, **User ID** and **Franchise ID**. If you don't know your User ID, click **Lookup** to search for it.
5. If it hasn't been auto-populated, select your **Fastway Franchise** from the dropdown menu.
6. Click **Save**.
### Request Aramex set up
Alternatively, you can ask our support team to set up your FastLabel account. Send an email to your Account Manager or reach out to our [support team](https://help.starshipit.com) with your company name, Aramex login email address, and API Key. Starshipit will forward this information to Aramex to activate your account. We will then notify you once this is done.
:::note
This step is only required if you're using Aramex and you haven't linked the accounts yourself.
:::
### Add product codes
To complete the integration between Starshipit and Fastway/Aramex, you need to add your product codes. The available product codes are:
* Parcel = 1
* Satchel A2 = 4
* Satchel A3 = 5
* Satchel A4 = 6
* Satchel A5 = 7
* Small Flat Rate Parcel = 16
* Medium Flat Rate Parcel = 17
* Large Flat Rate Parcel = 18
* Blue Zone = BLUE
* Black Zone = BLACK
* Yellow Zone = YELLOW
* Brown Zone = BROWN
* Lime Zone = LIME
* Pink Zone = PINK
* Red Zone = RED
* Orange Zone = ORANGE
* Green Zone = GREEN
* White Zone = WHITE
* Grey Zone = Grey
:::note
The Parcel service acts as a single service for all coloured label options. Aramex's API will choose the most appropriate coloured label when you use this service.
:::
## Returns
Returns with Aramex is supported for Aramex accounts. Returns are supported for domestic shipments within New Zealand and Australia.
### How to print a return label
1. Navigate to the printed or shipped tab and open the order you would like to add a return shipment to.
2. Select 'more actions' and click 'create a return order'
3. A return order will open - check the details are correct for your return shipment
4. Download or print your return label
:::note
To generate a returns label with Aramex you will need to ensure your outgoing shipment has an email associated with the sender.
:::
## Cancel orders
You can now cancel Aramex labels that have been printed in Starshipit.
### How to cancel an order
1. Navigate to **Settings** > **Couriers** > **Aramex** **Settings**.
2. Move to the **Tools** tab.
3. Under **Cancel a Shipment**, enter the tracking number of the order you would like to cancel.
4. Click **Cancel** to confirm.
## Troubleshooting
### No Aramex price or rate is shown
Starshipit can only show services and prices returned for your configured Aramex account and shipment. If no Aramex rate appears:
1. Go to **Settings > Couriers > Aramex** and confirm Aramex is enabled.
2. Confirm the selected API matches your account: **Use MyFastway API** for MyFastway, or the FastLabel fields for a legacy FastLabel account.
3. For MyFastway, confirm your **Client ID** and **Client Secret** are saved and **Use Version 2 Quotes API** is enabled.
4. Confirm the order uses an Aramex product code that is enabled in your courier settings. Use **Add default product codes** if the MyFastway codes are missing.
5. If a satchel service is missing, check the order weight. **Validate satchel weights** hides a satchel when the order exceeds its weight limit.
6. Compare the same shipment in the Aramex portal. If the portal also returns no rate, contact Aramex. If the portal returns a rate but Starshipit does not, [contact Starshipit support](https://help.starshipit.com) with the affected service and shipment details.
### Error: "Area Off Limit"
If you get an "Area Off Limit", your account does not have the correct user privileges activated.
To resolve this, send an email to [Fastway Australia](mailto:it.support@fastway.com.au)/[Aramex Australia](mailto:it.support@aramex.com.au) or [Fastway New Zealand](mailto:it.support@fastway.co.nz)/[Aramex New Zealand](mailto:it.support@aramex.com.au) and request access to your account. Once you receive a reply from Fastway, go back to the integration page and click **Lookup**.
### Price differences between Starshipit and the Aramex portal
1. The Aramex portal doesn't show you the fuel surcharge in the final cost whereas Starshipit will. Ensure you have compared the prices both with tax, fuel surcharge and base price.
2. There is additional charges for Signature Required. Try unticking the option and checking to see if this produces the rate you're expecting.
### Insufficient funds to complete this consignment
This error appears when your **Aramex account** does not have enough credit to create a shipment. It’s triggered by Aramex (not Starshipit) when your prepaid balance is too low or you have outstanding invoices.
**How to fix:**
1. Log in to your Aramex customer portal.
2. Check your account balance and any unpaid invoices.
3. Add credit or pay outstanding invoices.
4. Once your balance is updated, try creating the shipment again in Starshipit.
:::tip
This error is common with prepaid Aramex accounts and does not relate to your Starshipit billing.
:::
### Validate satchel weights
When **Validate satchel weights** is enabled, Starshipit checks whether the order weight is within the weight limit of a given satchel service. If the order exceeds the satchel's maximum weight, that satchel option will not be shown.
For example, if a satchel has a maximum weight of 500g and your order weighs 1kg, that satchel service will not appear as an available option.
### Other relevant information
To find out more about Aramex API, [click here](https://www.starshipit.com/blog-content/2019/05/21/are-you-a-fastlabel-customer-switch-to-myfastway-api-ship-faster)
---
# MyFastway Address Validation
URL: https://support.starshipit.com/articles/360003945975-myfastway-address-validation
Canonical: https://support.starshipit.com/articles/360003945975-myfastway-address-validation
Markdown: https://support.starshipit.com/articles/360003945975-myfastway-address-validation.md
Updated: 2026-05-06
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Learn why Aramex MyFastway labels cannot be generated unless addresses are an exact match.
* With Aramex (MyFastway), a label will not be generated unless there is an **exact match** at street level between the receiver address on your order and Aramex's/Fastway's address database.
* Starshipit will try to refine the receiver address on your orders as much as we can to prevent errors. However, this means that you may now need a higher level of address correction with your MyFastway labels to ensure a smooth process.
## Correcting your Receiver address
Make sure to check these specific things when correcting an address:
* Move any unit, level or floor numbers to the **Building** field.
* The street field can not contain ',' but can include '/'.
* Do not use "corner of". The street should be a number followed by a name.
---
# Set up Asendia
URL: https://support.starshipit.com/articles/90200000000083-set-up-asendia
Canonical: https://support.starshipit.com/articles/90200000000083-set-up-asendia
Markdown: https://support.starshipit.com/articles/90200000000083-set-up-asendia.md
Updated: 2026-03-12
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Step-by-step guide to setting up Asendia.
Connect Asendia to Starshipit to create shipping labels and track international parcels from Australia. Asendia specialises in cross-border e-commerce delivery through their E-PAQ product range.
## Before you begin
To connect Asendia to your Starshipit account, you need these credentials from Asendia:
* Username
* Password
* OAuth Client ID
* OAuth Client Secret
* Tracking Access Key
* Tracking API Key
## Set up Asendia in Starshipit
1. In Starshipit, go to **Settings** > **Couriers** > **Add a new courier**.
2. Choose **Australia** as your shipping origin.
3. Select **Asendia** from the International courier list.
4. Tick **Enable Asendia**.
5. If Asendia gave you test credentials, tick **Use UAT environment**.
6. Enter your **Username** and **Password**.
7. Enter your **Client ID** and **Client Secret**.
8. Enter your **Tracking Access Key** and **Tracking API Key**.
9. If Asendia supplied separate tracking OAuth credentials, enter the **Tracking Client ID** and **Tracking Client Secret**.
10. Click **Save**.
Your Asendia integration is now connected. You can verify the connection by creating a test shipment.
## Add product codes
Asendia shipments require a product code. Add the product codes enabled on your Asendia account in the **Add Product Codes** area.
Common Asendia product codes include:
| Code | Description |
| ---- | ----------- |
| E-PAQ Standard | Economy international delivery |
| E-PAQ Plus | Standard international delivery with tracking |
| E-PAQ Select | Premium international delivery |
| E-PAQ-SELECT-2 | Premium international delivery (variant) |
| E-PAQ Elite | Express international delivery |
If a product code is missing, contact Asendia to confirm it is enabled for your account.
## Customs declarations
Asendia supports full customs declarations for international shipments, including HS codes, declared values, reason for export, and incoterms (DDP, DAP, and others). Make sure your orders include accurate customs information to avoid delays at the border.
## Cancel a shipment
You can cancel Asendia shipments through the Starshipit portal. To do this, take the tracking number you'd like to cancel and go to:
1. **Settings** > **Couriers** > **FedEx** > **Tools**
2. Enter the tracking number in the displayed field.
3. Click **Cancel** to initiate the cancellation with Asendia.
## Limitations
* Asendia does not return live shipping rates in Starshipit.
* Only one package per order is supported. Split multi-item orders into separate shipments if needed.
* Returns, insurance, signature on delivery, and authority to leave are not available through this integration.
Add the services enabled on your Asendia account in **Add Product Codes**. If you use the **Cancel shipment** tab, enter the shipment's tracking number and select **Cancel shipment**.
## Troubleshooting
**I can't save my Asendia settings?**
Check that every credential field is filled in, then try saving again. If the issue continues, confirm with Asendia that your credentials are active and match the selected environment (UAT or production).
**Labels are not generating?**
Check that:
* Asendia is enabled in your courier settings.
* Your selected product code is available on your Asendia account.
* The shipment contains only one package.
**Tracking is not updating?**
Confirm your **Tracking Access Key** and **Tracking API Key** are correct. If tracking still does not update, contact Starshipit support with the tracking number and consignment ID.
---
# Australia Post and eParcel FAQs
URL: https://support.starshipit.com/articles/8412474309647-australia-post-and-eparcel-faqs
Canonical: https://support.starshipit.com/articles/8412474309647-australia-post-and-eparcel-faqs
Markdown: https://support.starshipit.com/articles/8412474309647-australia-post-and-eparcel-faqs.md
Updated: 2026-07-30
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Find answers to frequently asked questions about using Australia Post and eParcel with Starshipit.
Australia Post is no longer showing up in my shipping options
* Make sure that Australia Post is enabled as a carrier in your account settings.
* Ensure that the account details you've entered for Australia Post in Starshipit are correct. This includes your account number, API key, and any other necessary information.
* Make sure that your shipping rules do not exclude Australia Post for the products or destinations involved in the orders you're processing.
* Ensure that the weight and dimensions of your products are within the limits accepted by Australia Post.
Australia Post has updated my rates, do I need to do anything in Starshipit?
Yes, when Australia Post updates your rates, there are a few steps you need to take in Starshipit to ensure the changes are reflected correctly. Follow [this article](/articles/couriers/australia-post/australia-post-eparcel-how-to-update-your-rates) for more details.
If "Shipments will be manifested once at the end of the day" is enabled, what time will this manifest?
The shipments will be manifested at midnight (12:00 AM).
Can I print international labels on a thermal label printer?
Yes, follow the instructions in [this guide](/articles/couriers/australia-post/australia-post-eparcel-a6-cn22-labels).
How do I add an Export Declaration Number (EDN) to an Australia Post international shipment?
For goods sent from Australia with a value of AUD $2,000 or more, get an EDN from the Australian Border Force or your authorised export agent before printing the label. Open the order, select the Australia Post international service, then enter the EDN in **Customs details** > **Export number**. Do not enter an order, account, or invoice number in this field. An EDN is also required for goods that need an export permit, regardless of value. See [how to add an EDN to an Australia Post shipment](/articles/90200000000402-get-started-with-international-shipping).
Why are some of my international labels printed out differently?
CN22 have specific requirements to print A6 labels. You must meet the following criteria to enable an A6 (CN22) label, otherwise the system will default to the A5 (CN23) label:
* Parcel dimensions are less than or equal to 90 cm (L + W + D combined)
* The greatest parcel dimension is less than or equal to 60 cm
* Total consignment value is less than or equal to $500 AUD
* Parcel weight is less than or equal to 2 kg
* Parcel delivers to a country that permits the CN22 A6 label (refer to the table below)
Safe Drop is being pre-selected on Australia Post shipments but it should not be
The reason 'Safe Drop' was pre-selected on the shipments might be due to your account being set to 'Safe Drop' in the Australia Post portal at the account level. You can create a rule to ensure that all orders are set to 'Safe Drop = False' by default.
When generating an Australia Post label, if the receiver email field is empty do we override this and populate it with the user email? or do we leave it blank?
When the receiver's email field is empty, we populate the field with sender's email address.
Can I use express returns with Australia Post and what is the service code?
Yes, you can use Express Returns, however, by default the standard return service is used. You can use Express returns in your rules. Use the service 'PR' for standard returns and 'XPR' for express returns.
When does the return label within an outgoing order get manifested with Australia Post?
Both outgoing and return shipments will be manifested at the same time unless they create a separate return order, then they can manifest at different time.
Can I use a Parcel Send account with Starshipit?
Parcel Send uses the same API as eParcel which means you can use the same set up steps as Australia Post.
Does Starshipit support including Fuel Surcharges for Australia Post eParcel rates?
Yes, you can see fuel surcharges on Australia Post rates. To enable this:
* Navigate to **Settings** > **Couriers** > **Australia Post Settings** > **Advanced**.
* Tick **Include Surcharges with Rates**.
* Click **Save**.
Can I book a pickup with eParcel?
No, you cannot currently book a pickup with eParcel in Starshipit.
---
# Migrate from Australia Post eParcel to MyPost Business
URL: https://support.starshipit.com/articles/4870280289039-migrate-from-australia-post-eparcel-to-mypost-business
Canonical: https://support.starshipit.com/articles/4870280289039-migrate-from-australia-post-eparcel-to-mypost-business
Markdown: https://support.starshipit.com/articles/4870280289039-migrate-from-australia-post-eparcel-to-mypost-business.md
Updated: 2026-05-06
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Learn how to transition from Australia Post eParcel to MyPost Business with Starshipit.
{{video:youtube:4GUp_h5H8CY}}
* [How the MyPost Business integration works in Starshipit](/articles/couriers/australia-post/mypost-business-integration-faqs)
* [eParcel and MyPost Business - What's different?](#h_01G41D8G1C43JAKREHA1PRRW6H)
* [How to transition from eParcel to MyPost Business](#h_01G41DE55QNTW7BW239Y96WT52)
## How the MyPost Business integration works in Starshipit
Starshipit's integration with Australia Post MyPost Business allows you to use all of Starshipit's features including integrating with the likes of Shopify, generation of packing slips and shipping labels, auto-correction of addresses, branded tracking pages, tracking notifications, and many more.
Learn more about the MyPost Business integration [here](/articles/couriers/australia-post/mypost-business-integration-faqs).
## eParcel and MyPost Business - What's different?
* When printing MyPost Business labels in Starshipit your orders will skip the **Printed** tab. Orders will go directly to the **Shipped** tab when a label is printed.
* You do not need to manifest your orders
* CN23 labels (A4) are printed for International labels - CN22 international labels are not supported by MyPost Business at this time. Starshipit will include this feature when support is added.
* You can pay per shipment via a credit card or by using a charge account
## How to transition from eParcel to MyPost Business
#### **1. Manifesting your eParcel orders**
It is important to manifest your existing printed eParcel orders while your eParcel account is still active.
To do this:
1. Go to **Orders**, then select the **Printed** tab.
2. Click **Manifest**, then select **Manifest All**.
3. Click **Dispatch** to confirm. The manifest report will be downloaded automatically.
You can also download the report from the Manifest screen. From the sidebar, select Manifests, then click Download Report next to the order.
#### **2. Disabling your eParcel account in Starshipit**
You can disable your Australia Post eParcel account in Starshipit by:
1. Go to **Settings** > **Couriers**.
2. Next to Australia Post select **Settings**.
3. Untick **Enable Australia Post**.
4. Click **Save**.
#### **3. Integrate your MyPost Business account to Starshipit**
To set up MyPost Business, you will need the following:
* MyPost Business Email Address
* MyPost Business Password
* MyPost Business Merchant Token (Optional)
* MyPost Business Charge Account Number (Optional)
#### Using your MyPost Business Email Address and Password (recommended)
1. In [Starshipit,](https://app.starshipit.com/) go to **Settings** > **Couriers** > **Add New Courier** > select **MyPost Business**.
2. Click **Authorize**.
3. Enter your MyPost Business email address and password.
4. If prompted, review and accept any terms and conditions and enter your credit card details.
5. Your token, account number, and product codes should have been loaded after successfully logging in.
6. (Optional) If you're using a charge account click **Lookup** beside your Account Number > Click **Select** beside the charge account you want to enable.
:::note
Only charge accounts that are currently listed as active by MyPost will be shown in Starshipit. If your charge account isn't listed contact the MyPost Business team atcustomer_connectivity@auspost.com.au.
:::
#### Load your product codes
Select the MyPost Business products/services you would like to use:
1. In [Starshipit,](https://app.starshipit.com/) go to **Settings** > **Couriers** > **MyPost Business**.
2. Under Add product codes, click **Load products from MyPost Business**.
:::note
You should select a default international and domestic product code. This is the product code that will be automatically selected if your default carrier is MyPost Business.
:::
For more information on getting set up with MyPost Business, see our guide [here.](/articles/couriers/australia-post/set-up-australia-post-mypost-business)
#### **(Optional) Update your rules to allocate MyPost business to your orders automatically**
If you currently use rules to automatically assign orders to eParcel, you will need to update these to now allocate them to MyPost Business services.
1. In [Starshipit](https://app.starshipit.com/Account/MemberLogin.aspx), go to **Settings** > **Rules**.
2. Click **E****dit** next to any rule that says **AusPost**.
3. Update the courier to **Australia Post MyPost Business** and the appropriate product code.
4. Click **Save**.
#### **Starshipit is here to make this transition seamless**
We're here to help you along the way. If you need assistance with your migration to MyPost Business, please contact our support team [here](https://help.starshipit.com).
---
# Configure delivery options for Australia Post
URL: https://support.starshipit.com/articles/115000425263-configure-delivery-options-for-australia-post
Canonical: https://support.starshipit.com/articles/115000425263-configure-delivery-options-for-australia-post
Markdown: https://support.starshipit.com/articles/115000425263-configure-delivery-options-for-australia-post.md
Updated: 2026-07-23
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Learn how to configure delivery options for Australia Post orders.
Choose the Australia Post delivery options that apply by default to your orders, then update or re-import unshipped orders when you need a different option.
## About delivery options for Australia Post
Australia Post has three delivery options:
* **Authority to Leave (Safe Drop):** A signature and name will still be captured when your customer is at home. If they are not at home, the parcel will be left in a safe place if one is available, or a notification card left and the parcel taken to a nearby Post Office if no safe place is available
* **Authority to Leave (Safe Drop) can be requested by receiver:** A signature and name will be captured when your customer is at home. If they are not at home, the parcel will only be left in a safe place if your customer has requested this during the delivery process (through MyPost or through an invitation if they receive email tracking notifications). In all other cases, a notification card will be left and the parcel taken to a nearby Post Office.
* **Signature Required (card if not home):** A signature and name will always be captured and the parcel will be taken to a nearby Post Office if your customer is not at home to sign for the parcel.
For more detail on how Australia Post handles each delivery option, refer to the [eParcel Shipping and Tracking Fact Sheet](https://auspost.com.au/content/dam/auspost_corp/media/documents/eparcel-shipping-and-tracking-fact-sheet.pdf).
| Service Code | Description |
| ------------ | ----------- |
| 50 | Authority To Leave can be requested by receiver (full consignment must be delivered together) |
| 51 | Authority To Leave can be requested by receiver (partial consignment delivery allowed) |
| 03 | Signature required (card if not home) |
| 08, 15 | Signature On Delivery with Authority To Leave |
## Edit delivery options in Starshipit
1. In your Starshipit account, navigate to **Settings** \> **Couriers**.
2. Click Australia Post **Settings**.
3. Select **Advanced** tab, and make your changes accordingly.The **Safe Drop** option is enabled by default. You can clear this checkbox to enforce a signature on delivery or tick authority to leave to enforce authority to leave.
4. Click **Save**.
## Wine and liquor shipments to Victoria
For eligible Australia Post wine and liquor services delivered to Victoria, Starshipit shows the **First Time Delivery** option. Eligible product codes are `3O85`, `3P85`, `3V85`, `7O35`, `7O85`, `7N35`, and `7N85`.
First Time Delivery is enabled by default for eligible services. When it is enabled, Starshipit sends the shipment as identity-on-delivery and turns off Authority to Leave, Safe Drop, and partial delivery for the eligible package.
Use First Time Delivery for a first-time customer or gift recipient who needs addressee-only delivery. Australia Post also uses these product codes for some non-alcohol shipments, so clear the option when those delivery controls are not required.
To change the default for new eligible orders:
1. Go to **Settings > Couriers**.
2. Open **Australia Post** settings, then select **Advanced**.
3. Select or clear **First Time Delivery**.
4. Click **Save**.
You can also select or clear **First Time Delivery** on an eligible order before printing its label. The option appears only when the destination is Victoria and the selected service uses one of the eligible product codes.
### Service codes for eligible liquor services
| First Time Delivery | Delivery option | Australia Post service code |
| --- | --- | --- |
| Enabled | Delivery controls are set automatically | `49` |
| Disabled | Authority to Leave | `82` |
| Disabled | Signature required | `81` |
| Disabled | Safe Drop can be requested by the receiver | `83` |
## Remove and re-import orders
If you have made changes to your delivery options, you can remove and re-import orders to apply these changes.
1. In your Starshipit account, select **Orders**.
2. Click **Actions**, then select **Remove imported unshipped orders** from the dropdown menu.
3. Click **Remove**.
4. After you have removed unshipped orders, click **Import**, then select **Import All** from the dropdown menu.
---
# Manifest Australia Post eParcel orders
URL: https://support.starshipit.com/articles/14700000000059-manifest-australia-post-eparcel-orders
Canonical: https://support.starshipit.com/articles/14700000000059-manifest-australia-post-eparcel-orders
Markdown: https://support.starshipit.com/articles/14700000000059-manifest-australia-post-eparcel-orders.md
Updated: 2026-08-21
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Manifest Australia Post eParcel and Parcel Send orders in Starshipit before handing them to Australia Post.
Manifest your Australia Post eParcel or Parcel Send orders in Starshipit after printing their labels, so Australia Post receives the shipment details before handover.
## Before you begin
- Set up Australia Post eParcel or Parcel Send in Starshipit. See [Set up Australia Post eParcel or Parcel Send](/articles/couriers/australia-post/set-up-australia-post-eparcel-parcel-send).
- Print labels for the orders you want to hand over. Printed orders appear in the **Orders** > **Printed** tab.
:::important
Australia Post eParcel and Parcel Send orders must be manifested. MyPost Business orders do not use this eParcel manifesting process.
:::
## Manifest selected orders
1. Go to **Orders** > **Printed**.
2. Select the Australia Post eParcel or Parcel Send orders you want to hand over.
3. Click **Manifest orders**.
4. Click **Manifest** to send the shipment details to Australia Post.
The manifested orders move out of the **Printed** tab when the manifest is complete.
## Manifest all printed Australia Post orders
1. Go to **Orders** > **Printed**.
2. Click **Manifest all**.
3. Click **Manifest** to confirm.
Use this option only when every eligible printed order is ready to hand over.
## Download the manifest report
Your Australia Post driver or lodgement point may ask for a paper copy of the manifest.
1. Go to **Manifest**.
2. Find the completed manifest.
3. In the **Downloads** column, click **Report**.
4. Print the report if it is required for your handover.
## Troubleshooting
### I cannot see an order to manifest
Check that the order has an Australia Post eParcel or Parcel Send label and is in the **Printed** tab. Orders that are already manifested will not appear there.
### Australia Post says a shipment was not manifested
Search for the order by its tracking number and check its status. If the order was archived before it was manifested, restore it, then manifest it before handing it over to Australia Post.
## Related articles
- [Manifest orders](/articles/orders-manifests-reports/manifests-and-pickups/manifest-orders)
- [Australia Post and eParcel FAQs](/articles/couriers/australia-post/australia-post-eparcel-faqs)
---
# Set up Australia Post eParcel or Parcel Send
URL: https://support.starshipit.com/articles/202767419-set-up-australia-post-eparcel-or-parcel-send
Canonical: https://support.starshipit.com/articles/202767419-set-up-australia-post-eparcel-or-parcel-send
Markdown: https://support.starshipit.com/articles/202767419-set-up-australia-post-eparcel-or-parcel-send.md
Updated: 2026-05-27
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Set up Australia Post eParcel or Parcel Send in Starshipit.
* Australia Post's [integration with Starshipit](https://www.starshipit.com/partner/australiapost) allows you to use all of [Starshipit's features](https://www.starshipit.com/features) including generating packing slips and shipping labels, auto-correction of addresses, branded tracking and notifications and many more.
* This article outlines how to set up Australia Post as a courier service in Starshipit.
* Don't have an eParcel/Parcel Send account? No worries, get shipping right away with Australia Post's instant shipping provider [MyPost Business](/articles/couriers/australia-post/set-up-australia-post-mypost-business).
## What you need to get started
* Australia Post eParcel/Parcel Send Account Number
* Australia Post API Key & Australia Post API Secret
If you are missing any of these credentials, [generate an API key and Secret](/articles/couriers/australia-post/generate-an-australia-post-startrack-api-key-and-secret) through the eParcel developers center.
* IC13 is a supported product code, read more about IC13 and return addresses [here](https://developers.auspost.com.au/apis/shipping-and-tracking/info/product-business-rules/global-logistics).
## How to set up Australia Post eParcel
### 1. Enter your API details in Starshipit
1. Go to **Settings** > **Couriers** > **Add a new courier** > **Australia Post**.
2. Tick **Enable Australia Post**.
3. Enter your Account Number, Authorisation Key, and Password (API Secret).
4. Click on **Look-up** to get your MLID.
5. For the current increment, this will only need to be changed if you have used this Australia Post account on another platform or integration. If you have, we recommend increasing the base number by 1 million. This value should not exceed 7 digits.
6. Click **Save**.
### 2. Load your product codes
Click on **Load products from AusPost** to load all of your product codes from Australia Post.
Make sure to select a default international and domestic product code. This is the product code that will be automatically selected if your default carrier is Australia Post.
:::note
If some of them are missing, contact customer_connectivity@auspost.com.au or your Australia Post eParcel account and ask them to assign them to your account.
:::
### 3. (Optional) Set up default export type
If shipping internationally, you will need to configure which export type your goods fall under (Sale of Goods, Gifts, Returns, Samples. You can do this by going to **Settings** > **Couriers** > **Advanced** and selecting the correct option from the drop-down.
## Additional configuration
Australia Post eParcel offers additional configurations which you can find in the Australia Post eParcel courier settings.
**Label sheets**: Remove extra spaces if you don't have a label printer and would like to print 4 labels to 1 A4 page, see our guide on how to configure this: [How to print Australia Post shipping labels 4 per page](/articles/couriers/australia-post/how-to-print-australia-post-shipping-labels-4-per-page).
**CN22/Thermal international**: Australia Post eParcels default international labels are A4. If you'd like to use their smaller label, read our guide on how to set up CN22's: [Australia Post eParcel A6 CN22 Labels](/articles/couriers/australia-post/australia-post-eparcel-a6-cn22-labels).
**Returns**: To enable returns with Australia Post eParcel, go to **Settings > Couriers > Advanced** and tick **Enable Returns**. For more on how returns works with Starshipit, see here: [Returns with Starshipit](/articles/returns/returns/returns-with-starshipit).
**Transit times**: If you're using [live rates at checkout](/articles/rates-at-checkout/set-up-guides/about-live-rates-at-checkout-supported-couriers), you can enable transit times to display by ticking Display transit times.
**Packages on checkout**: By default, when using [live rates at checkout](/articles/rates-at-checkout/set-up-guides/about-live-rates-at-checkout-supported-couriers) with eParcel, orders exceeding 22kg are automatically split into multiple packages, and the rates are combined. To disable this and limit checkout rates to a single package (22kg domestic, 20kg international), go to **Settings > Couriers > Australia Post > Advanced** and tick **Limit checkout rates to a single package**.
## Troubleshooting
#### Could not find sender locality
This error usually means the sender suburb or locality does not match Australia Post's official suburb data for the sender postcode and state.
Check the sender address in **Settings** > **Options** > **Sender Details** and make sure:
* The suburb or locality is entered in the suburb/locality field, not only in the city field.
* The postcode and state match the suburb.
* The suburb spelling matches the official Australia Post suburb name.
* The sender address includes a street or building and either a contact name or company name.
If the suburb, postcode, and state look correct but the error continues, confirm the address against [Australia Post's postcode search](https://auspost.com.au/apps/postcode) and update the sender details to use the official suburb name.
#### Labels are printing out of order
If Australia Post labels are printing out of order, go to **Settings** > **Couriers** > **Australia Post** > **Advanced** and enable:
* **Let AusPost generate domestic labels**
* **Use new implementation of AusPost**
Save your settings, then try printing the labels again.
#### 401: Access to the requested resource is controlled by an API key and password
The below 401 error will come up when your API key and secret are valid but services are not turned on in the Australia Post developers centre.
```
"errors": [
{
"code": "401",
"name": "Unauthorized",
"message": "Access to the requested resource is controlled by an API key and password. The API key and password supplied in the request does not authenticate or authorise you to use the resource. If you believe you are receiving this message in error, please contact your Account Manager or call Australia Post on 13 21 31."
}
]
```
#### The request failed authentication
A request that has invalid key details will provide a error message "The request failed authentication". This is due to an invalid key and/or secret.
#### 401: Unauthorized: The API key and password used to authenticate this request cannot be used to transact on the charge account
A key that is valid but is being used to access an account that it is not linked to will return the below error. This is due to an invalid key, un-linked or invalid charge account number.
This can also be due to the account number being incorrect. Add three zeros (000) to the front of the account number and try saving the integration settings again.
```
"errors": [
{
"code": "401",
"name": "Unauthorized",
"message": "The API key and password used to authenticate this request cannot be used to transact on the charge account with account number 0001234567. If you believe you are receiving this message in error, please contact your Account Manager or call Australia Post on 13 21 31."
}
]
```
## Other relevant information for you
* Read more about Australia Post [eParcel system.](https://auspost.com.au/business/shipping/manage-your-shipping/eparcel)
* To learn more about APIs and their importance, [click here.](https://www.starshipit.com/blog-content/tech-101-series-apis-explained?rq=API)
---
# Set up Australia Post eParcel returns
URL: https://support.starshipit.com/articles/360002064896-set-up-australia-post-eparcel-returns
Canonical: https://support.starshipit.com/articles/360002064896-set-up-australia-post-eparcel-returns
Markdown: https://support.starshipit.com/articles/360002064896-set-up-australia-post-eparcel-returns.md
Updated: 2026-05-06
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Set up Australia Post eParcel returns in Starshipit.
* Australia Post eParcel returns provide a convenient and efficient way to manage the return of goods from customers.
* This article outlines how to set up Australia Post returns on your Starshipit account.
## Before you begin
Ensure that you have Australia Post eParcel set up in your courier settings, and returns pricing on your Australia Post eParcel account.
## 1. Enable returns in Australia Post settings
1. In your Starshipit account, go to **Settings.**
2. Select **Couriers** from the left menu.
3. Click **Settings**, next to **Australia Post**.
4. Select the **Advanced**tab, then tick **Enable Returns**.
5. Click **Save** at the bottom of the Advanced tab.
## 2. (Optional) Add additional return product codes
By default your Australia Post eParcel account will be set up with the product code **PR** for returns. This is the most common code loaded by Australia Post eParcel.
Please note the PR code will not show up under your product code settings in **Settings** > **Couriers** > **Australia Post**.
To add the product codes:
1. In your Starshipit account, go to **Settings.**
2. Select **Couriers** from the left menu.
3. Click **Settings**, next to **Australia Post**.
4. Click **Add a new product code.**
5. Enter the code, and name, and set the type as **Domestic**.
Supported codes include:
* PR - eParcel Post Returns
* PR1 - eParcel Post Returns - Zonal 1
* PR2 - eParcel Post Returns - Zonal 2
* XPR - Express eParcel Post Returns
* XPR1 - Express eParcel Post Returns - Zonal 1
* XPR2 - Express eParcel Post Returns - Zonal 2
## 3. (Optional) Manifest return orders on label print
When using return labels with Australia Post, it’s crucial to ensure that the orders are properly manifested. Many post offices will not accept return shipments if the return label hasn't been included in a manifest, especially when the customer is returning the parcel themselves.
Australia Post returns labels, once manifested, will **not appear on AusPost manifest reports**. This is expected behaviour from Australia Post and does not affect the validity of the return label. Only outbound consignments will be listed in the manifest reports.
To prevent any issues or delays with your returns, we recommend enabling the option to automatically manifest return orders on label print. You can find this option in your Starshipit account by navigating to:
1. **Settings** > **Couriers** > **Australia Post Settings** > **Advanced**.
2. Tick the option to **Manifest Return Orders on Label Print**.
3. Click **Save**.
---
# Update Australia Post eParcel rates
URL: https://support.starshipit.com/articles/6759992720399-update-australia-post-eparcel-rates
Canonical: https://support.starshipit.com/articles/6759992720399-update-australia-post-eparcel-rates
Markdown: https://support.starshipit.com/articles/6759992720399-update-australia-post-eparcel-rates.md
Updated: 2026-05-06
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Update Australia Post eParcel rates in Starshipit.
## How do my eParcel rates feed through to Starshipit?
* Starshipit is connected to eParcel's system via an API integration. This means the rates you see in Starshipit will update automatically when Australia Post makes any changes to your account.
* When you have an upcoming change to your contract, Australia Post will inform you of your new "contract codes" as well as when they will be going live. Contract codes are 4-character alphanumeric values that typically look like **3D85**, **7J35**. You will have one for Parcel Post and one for Express Post shipments.
* In Starshipit, we refer to these as product codes and you can find your current ones listed in **Settings** > **Couriers** > **Australia Post** > **Product Codes**
## Checklist
* Before eParcel switches your codes over, you will want to make sure everything printed on your old code is manifested. Go to the printed tab and select **Manifest All**. Failing to do this may cause issues with manifesting your shipments if the contract they were generated on does not exist any longer.
* To check if your contract has been changed, go to **Settings** > **Couriers** > **Australia Post** > **Load Product Codes.** This will pull the latest product codes you have with eParcel onto your account
* Ensure your rules have been updated to assign your new product codes. Go to Settings > Rules and look for any that are assigning Parcel Post or Express Post and update them to your new coded services.
* If you use checkout rates, you will need to configure your new codes to show on checkout. Go to **Settings** > **Checkout Rates** > **Courier Configuration** > **Ensure the new services are ticked**
## FAQ
Why do I have two sets of rates showing in Starshipit?
Starshipit will display everything that is on your contract with eParcel. If you have two sets showing, this is because eParcel has not yet disabled the old contract. Often Australia Post will provide a buffer period where both your old services and new services are on your account so that you can manifest any of your old shipments before they remove your access to them. They typically will drop off automatically after a few days, however, if they have not you can contact Australia Post to remove them.
I clicked **Load Product Codes** but nothing showed up in my products list
This means there has been a configuration issue with Australia Post. You will need to ask them to check your contract and ensure your new rates are loaded and available via the API. As soon as it is set up correctly on Australia Post's side it will display in Starshipit.
---
# Australia Post prepaid labels and satchels FAQs
URL: https://support.starshipit.com/articles/360001579896-australia-post-prepaid-labels-and-satchels-faqs
Canonical: https://support.starshipit.com/articles/360001579896-australia-post-prepaid-labels-and-satchels-faqs
Markdown: https://support.starshipit.com/articles/360001579896-australia-post-prepaid-labels-and-satchels-faqs.md
Updated: 2026-05-06
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Find answers to frequently asked questions about Australia Post MyPost Business and prepaid.
**Do you integrate with MyPost Business?**
Yes! MyPost Business is now supported and you can read about the integration [here](/articles/couriers/australia-post/mypost-business-integration-faqs).
**How does using Starshipit with prepaid labels and satchels work?**
First, integrate all your sales channels into your Starshipit account. For example, you may sell on Shopify, eBay and over the phone.
Then, [set up our Plain Label option](/articles/couriers/plain-label/how-to-use-plain-labels?_ga=2.89821656.297958530.1590356296-631748550.1499037703) and generate your shipping labels.
If you use other dispatch options, you can manage them all here too. For example, if you use Australia Post prepaid, another courier, and offer pick-up in store, add them all into Starshipit and manage your workflow in one platform.
**I want to store tracking numbers for prepaid satchels and labels. How does that work?**
Scan or enter the tracking number on the satchel in the tracking field on the order page.
**NB:** With prepaid satchels a 2D barcode scanner is required to scan QR codes (e.g the Datalogic Gryphon D4520). You may need to program your scanner to ignore the first and last series of numbers that are not the tracking number.
**Can I send tracking information to my customers?**
Yes, but only on the **Printed** status. With each plain label you set up (you can set up to a maximum of 5), you can specify the tracking URL which will be combined with the tracking number when the order is processed.
### **What's Next?**
Set up Australia Post prepaid in Starshipit using the [plain label functionality](/articles/couriers/plain-label/how-to-use-plain-labels?_ga=2.89821656.297958530.1590356296-631748550.1499037703).
---
# Set up Australia Post eParcel lodgement points
URL: https://support.starshipit.com/articles/360001913715-set-up-australia-post-eparcel-lodgement-points
Canonical: https://support.starshipit.com/articles/360001913715-set-up-australia-post-eparcel-lodgement-points
Markdown: https://support.starshipit.com/articles/360001913715-set-up-australia-post-eparcel-lodgement-points.md
Updated: 2026-05-06
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Set up Australia Post eParcel lodgement points in Starshipit.
* This article outlines how to set up multiple Australia Post eParcel lodgement points in Starshipit.
## What is a lodgement point
A lodgement point is where your packages will be dropped off, picked up, and taken to by Australia Post. In most cases a lodgement point will be a post office, however parcel facilities such as the Melbourne Parcel Facility or Sydney Parcel Facility can also be lodgement points.
Each Australia Post eParcel account will have a lodgement point associated with it. Check with your Australia Post account manager if you are unsure which lodgement point(s) you use.
## How to use lodgement points
If your business uses two or more lodgement points then this will mean you have two or more Australia Post eParcel accounts.
Starshipit can support multiple lodgement points through the use of child accounts. Child accounts are part of an account hierarchy, in essence they are sub accounts that sit under your main Starshipit account. Each child account can have its own pick up address or in this case lodgement point.
---
# Set up Australia Post MyPost Business
URL: https://support.starshipit.com/articles/360003690095-set-up-australia-post-mypost-business
Canonical: https://support.starshipit.com/articles/360003690095-set-up-australia-post-mypost-business
Markdown: https://support.starshipit.com/articles/360003690095-set-up-australia-post-mypost-business.md
Updated: 2026-05-06
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Step-by-step guide to setting up Australia Post MyPost Business.
Connect [Australia Post MyPost Business](https://starshipit.com/nz/auspost-mypost-business-shipping-app) to Starshipit to ship domestically and internationally from Australia. You can sign up and start shipping immediately using a credit card — no account contract required. Learn more about [how the MyPost Business integration works](/articles/couriers/australia-post/mypost-business-integration-faqs).
{{video:youtube:YNqspT5VfCc}}
## Before you begin
* Your MyPost business login details. If you don't have an account, [sign up here.](https://auspost.com.au/mypost-business/auth/email)
* Payment method, either a credit card, or if spending more than $1000 a month you can apply for a credit account through [MyPost Business](https://auspost.com.au/business/business-admin/business-credit-accounts-postage-meters/business-credit-account)
## Set up Australia Post MyPost Business in Starshipit
1. In [Starshipit,](https://app.starshipit.com/) go to **Settings** > **Couriers** > **Add New Courier** > select **MyPost Business**.
2. Tick **Enable MyPost Business**
3. Click **Authorise**. This will redirect you to the MyPost Business website to log in.
4. Enter your MyPost Business **email address** and **password**
5. If prompted, review and accept any terms and conditions and enter your credit card details.
This is required to integrate the account. You can change to using a charge account once the integration is completed.
6. (Optional) If you're using a charge account, under **Payment method** click **Lookup** and select the charge amount you want to enable.
7. Click **Load products from MyPost Business** to add the services, and delete any you don't want to use.
MyPost Business is now ready to use on your Starshipit account.
:::note
Only charge accounts that are currently listed as active by MyPost will be shown in Starshipit.
If your charge account isn't listed, contact the MyPost Business team at customer_connectivity@auspost.com.au.
:::
## Additional configuration
Australia Post MyPost Business offers additional configurations which you can find in their courier settings.
**Limit extra cover**: If you are using the free insurance with MyPost this setting will cap the cover value at the free threshold ($100).
**SKUs on labels**: Enabling this setting will add the SKUs to the MyPost labels.
**Export type**: Select the default export type for your goods when shipping internationally. The most common is Sale of Goods.
**Digital signature**: Tick Automatically add digital signature to international labels if you'd like Starshipit to automatically sign and date your international orders with your company name.
**Multi-package**: MyPost only supports single package shipments. Tick Enable Multi-Package Creation for Domestic Shipments if you'd like to create multiple (separate) labels for your orders from one order in Starshipit. Note: These will be billed as separate consignments with MyPost.
---
# Configure Australia Post notifications
URL: https://support.starshipit.com/articles/115001354466-configure-australia-post-notifications
Canonical: https://support.starshipit.com/articles/115001354466-configure-australia-post-notifications
Markdown: https://support.starshipit.com/articles/115001354466-configure-australia-post-notifications.md
Updated: 2026-05-06
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Learn how to activate Australia Post Notifications.
* Learn how to activate Australia Post Notifications
:::warning
If you have enabled eParcel notifications, please ensure you have not enabled the Starshipit notification to avoid sending duplicate notifications.
:::
## How to activate the eParcel Email/Text notifications
These are not managed by Starshipit, however, they can be activated via your Starshipit account
1. Go to **Settings** > **Couriers**> **Australia Post** > **Advanced**.
2. Tick the **Enable Email Notification for Tracking** option.
3. Click **Save**.
---
# Use Australia Post Postage Paid
URL: https://support.starshipit.com/articles/8358752602383-use-australia-post-postage-paid
Canonical: https://support.starshipit.com/articles/8358752602383-use-australia-post-postage-paid
Markdown: https://support.starshipit.com/articles/8358752602383-use-australia-post-postage-paid.md
Updated: 2026-05-06
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Learn what Australia Post Postage Paid is and how to use it in Starshipit.
* Postage Paid is a pre-printed impression that serves as an alternative to postage stamps or a postage meter.
* The Australia Post Mail label comes with a postage paid imprint. It is suitable for customers who send regular quantities of mail, or small items such as seeds.
* This guide provides step-by-step instructions on setting up and using Australia Post Mail labels effectively for your shipping need.
## How to set up Australia Post Postage Paid
:::note
When scanning Australia Post prepaid satchels/labels, you need to use a barcode scanner which supports scanning 2D barcodes.
:::
1. Go to **Settings** > **Couriers**.
2. Click **Add a new courier**.
3. Click **Australia Post Mail**.
4. Select **Enable Australia Post Mail**.
5. (Optional) – Enable additional options.
6. Click **Save**.
## Additional options
| Option | Description |
| --- | --- |
| **Enable Postage Paid Priority Stamp for Australia Post** | The Postage Paid Priority imprint is automatically added to labels |
| **Hide sender address** | Remove the sender address from the label |
| **Hide barcode** | Remove the order number from the label |
| **Show receiver phone number** | Display the receiver phone number on the label |
| **Display item SKUs on labels** | Displays your item SKUs on labels |
| **Use tracking number when available for barcode** | The tracking barcode is displayed on labels |
| **Use Reference field on label (as opposed to Order Number)** | Choose whether you'd like to have your order number or the reference number printed on the shipping label |
## FAQs
**How do I pay for Australia Post Postage Paid?**
You can use an Australia Post Business Credit Account (or cash) to pay for Postage Paid Imprint mail.
## Configure Australia Post Mail settings
The Australia Post Mail settings include the following controls. Enable only the options that match how you prepare mail:
| Setting | What it controls |
| --- | --- |
| **Enable Australia Post Mail** | Makes postage-paid labels available. |
| **Hide Sender Address** | Removes the sender address from the label. |
| **Hide Barcode** | Removes the barcode from the label. |
| **Show receiver phone number** | Prints the receiver's phone number. |
| **Display item SKUs on labels** | Prints item SKUs on the label. |
| **Use tracking number when available for barcode** | Uses a tracking number for the barcode when Australia Post provides one. |
| **Use Reference field on labels** | Uses the order's Reference instead of Order Number on the label and barcode. |
| **Enable Postage Paid Priority Stamp for Australia Post** | Adds the priority postage-paid imprint. |
---
# MyPost Business integration FAQs
URL: https://support.starshipit.com/articles/360003680775-mypost-business-integration-faqs
Canonical: https://support.starshipit.com/articles/360003680775-mypost-business-integration-faqs
Markdown: https://support.starshipit.com/articles/360003680775-mypost-business-integration-faqs.md
Updated: 2026-05-06
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Find answers to frequently asked questions about MyPost Business integration.
Find answers to frequently asked questions about the MyPost Business integration on Starshipit. If you haven’t set up your MyPost account yet, follow the steps in [this guide](/articles/couriers/australia-post/set-up-australia-post-mypost-business).
How does label printing and manifesting work?
MyPost Business shipments can be processed in the same way as any other courier on Starshipit.
MyPost Business orders do not require manifesting. All charges (credit card or business accounts) are applied as soon as the label is printed, and orders move straight to the Shipped tab.
Learn more [about printing labels on Starshipit](/articles/printing-labels-packing-slips/printing/about-printing-and-labels).
What size labels does MyPost support?
Two label sizes are available for domestic shipments:
* 100x150mm (A6)
* Four A6 labels on an A4 sheet
For international shipments:
* CN23 (A5) labels printed on A4 paper
When and how are charges applied?
**Credit card / debit card**
Each time you print a MyPost Business label, your credit card is charged by Australia Post as one transaction. If you print labels individually, each print appears as a separate transaction. If you bulk print, the charges are consolidated into one transaction.
**Charge account**
Each time you print a label, the amount is added to your MyPost Business charge account. You can then make payments to your account outside of Starshipit.
To set up a charge account:
1. Go to **Settings** > **Couriers** > **MyPost Business Settings**.
2. Click **Lookup** next to the Account Number field.
3. Click **Select** next to the row with Account Type “Charge”.
4. Click **Save**.
How can I cancel a shipment and get a refund?
:::note
Only payments made by credit or debit card can be refunded online. Charge account customers must contact Australia Post Customer Service to request a refund.
:::
MyPost Business shipments must be cancelled from within the MyPost Business portal.
1. Log into the [MyPost Business dashboard](https://auspost.com.au/mypost-business/dashboard#/home).
2. Click the **Track** tab.
3. Find the shipment you want to cancel, then click **View**.
4. Click **Refund** in the top right.
If the Refund button is not displayed, the shipment is ineligible. See the [MyPost Business Support section](https://auspost.com.au/help-and-support#/help_and_support/search_for#pageURL=mypost_business.html) in the portal for a full list of reasons.
:::note
For charge account refunds, you need to lodge a case with Australia Post directly.
:::
How do pickups work?
You can book pickups for MyPost Business in two ways:
**Book automatically on bulk print**
1. Go to **Settings** > **Couriers** > **MyPost Business**.
2. Tick **Book pickups on bulk label print**.
3. Click **Save**.
When you bulk print, a pickup is booked for the next business day. You must bulk print before 1pm the day prior — pickups are collected between 9am and 5pm (Monday to Friday, excluding public holidays).
MyPost Business has a limit of 100 packages per pickup. Print all of your daily labels in one bulk print session, as Australia Post charges $11.98 per pickup.
**Book manually (ad-hoc)**
You can also book pickups manually using the [Book Pickup feature](/articles/orders-manifests-reports/orders/book-a-courier-pickup).
1. Go to the **Printed** or **Shipped** tab, or the **Pickups** page.
2. Click **Book Pickup**.
3. Follow the prompts to schedule the pickup.
This method doesn’t require printing labels first and gives you more flexibility.
Is there a cut-off time to organise a pickup?
Yes. You must book before **1pm the day prior**. Pickups are collected between 9am and 5pm the following business day (Monday to Friday, excluding public holidays).
What is the difference between the MyPost service codes?
MyPost Business has two service types: Flat Rate Satchels/Boxes and Parcel services. If you’re using branded Australia Post boxes and satchels, use the flat rate codes. If you’re using your own packaging, use the parcel services. Contact Australia Post for more detail.
**B20 and B30 vs B21 and B31**
* B20 — Express Post, under 5kg
* B30 — Standard Post, under 5kg
* B21 — Express Post, 5kg to 22kg
* B31 — Standard Post, 5kg to 22kg
Starshipit automatically displays the service that matches your package dimensions, including in live rates.
Can I insure my MyPost Business packages?
Yes. MyPost Business supports “Extra Cover” insurance. Cover for the first $100 is free for both domestic and international shipments.
To insure an order individually:
1. Open the order.
2. Tick **Cover/Warranty Required**.
3. Enter a cover value.
4. Click **Print**.
To automatically apply cover using a rule:
1. Go to **Settings** > **Rules** > **Create a new Rule**.
2. Select your conditions.
3. Set the action to **Set Insurance Required** – Value: True.
To cap insurance at $100 (free tier only):
1. Go to **Settings** > **Carriers** > **My Post Business Settings** > **Limit Extra Cover to $100**.
Are returns supported with MyPost Business?
No. Returns are not currently supported for MyPost Business shipments in Starshipit.
---
# Generate an Australia Post or StarTrack API key and secret
URL: https://support.starshipit.com/articles/115000815923-generate-an-australia-post-or-startrack-api-key-and-secret
Canonical: https://support.starshipit.com/articles/115000815923-generate-an-australia-post-or-startrack-api-key-and-secret
Markdown: https://support.starshipit.com/articles/115000815923-generate-an-australia-post-or-startrack-api-key-and-secret.md
Updated: 2026-05-06
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Learn how to generate your Australia Post or StarTrack API key and connect it to Starshipit.
Generate your Australia Post or StarTrack API key and connect it with Starshipit to automate checkout options and label generation. This guide explains how to create your API key using your existing Australia Post account.
## Before you begin
* Your Australia Post (eParcel) or StarTrack account number.
* An active **Australia Post Business Credit Account** and an **eParcel Contract**. If you don’t have an account, visit [Australia Post’s website](https://auspost.com.au/business/shipping/manage-your-shipping/eparcel) to register your interest. Mention that you’re using Starshipit.
* Alternatively, if you don’t have one of these accounts, sign up with [MyPost Business](/articles/couriers/australia-post/set-up-australia-post-mypost-business).
## Create your API key
To create your API key, you must sign in with the same Australia Post account that is linked to your eParcel or StarTrack account.
If you sign in with a different Australia Post account (one that does not match your account number), you’ll be prompted to log in again with the correct one.
1. Go to the [Australia Post Developer Centre](https://developers.auspost.com.au/apis).
2. Log in using your existing Australia Post account credentials.
3. Select **Register for a key** under **Shipping & Tracking**.
4. Complete the registration form using your Australia Post, StarTrack, or Same Day/On Demand account details.
5. When asked if you’re accessing the API via a Platform Partner, select **Yes** and choose **Starshipit**.
6. Click **Next** and follow the remaining prompts to complete registration.
Once your registration is approved, Australia Post will email you a PDF containing your API credentials - usually within 24 hours. Follow the instructions in the email or PDF to generate your API key.
:::note
If you haven’t received the email within 24 hours, check your junk or spam folder. You can also contactcustomer_connectivity@auspost.com.auor your e Parcel Account Manager for assistance.
:::
## Add eParcel to your account
* You can add eParcel yourself by following [this guide](/articles/couriers/australia-post/set-up-australia-post-eparcel-parcel-send).
* If you need help, contact our support team [here](https://help.starshipit.com) with your account number, API key and secret.
## Troubleshooting / FAQs
**Why am I being asked to log in again?**
You’re logged in with a different Australia Post account than the one linked to your account number. Log out and log in again with the correct account.
**I didn’t receive my API key email.**
Check your junk/spam folder or contact [customer_connectivity@auspost.com.au](mailto:customer_connectivity@auspost.com.au). Approval usually takes up to 24 hours.
**Who should I contact for technical issues?**
Reach out to the Australia Post Service Desk at [customer_connectivity@auspost.com.au](mailto:customer_connectivity@auspost.com.au) or call 03 9106 7232 / 02 8755 9417.
---
# Use Australia Post generated labels
URL: https://support.starshipit.com/articles/4402418215695-use-australia-post-generated-labels
Canonical: https://support.starshipit.com/articles/4402418215695-use-australia-post-generated-labels
Markdown: https://support.starshipit.com/articles/4402418215695-use-australia-post-generated-labels.md
Updated: 2026-05-06
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Use Australia Post labels generated outside Starshipit when your workflow requires them.
* Starshipit's integration with Australia Post means that Starshipit can generate Australia Post labels for you.
* However, there are times when you may like to use the labels that Australia Post generate from their systems.
* This guide shows you how you can enable/disable using Australia Post generated labels.
## Use cases
Common reasons to use Australia Post generated labels include:
* Australia Post has requested that your labels show the Suburb, State and Postcode all on one line.
* You're using pre-branded label sheets from Australia Post.
:::note
These labels do not get returned from Australia Post in any sorted order. If you are printing in bulk and require the labels to be in the same order as the orders grid, please contact our support teamhere.
:::
## How do set up Australia Post generated labels
To set up Australia Post generated labels, go to:
* In [Starshipit](https://app2.starshipit.com/), navigate to **Settings** > **Couriers** > **Australia Post Settings** > **Advanced**.
* Tick **Let AusPost generate domestic labels**.
* Click **Save**.
If you use Australia Post Express labels, we recommend also enabling the below setting:
* In [Starshipit](https://app2.starshipit.com/), navigate to **Settings** > **Couriers** > **Australia Post Settings** > **Advanced**.
* Scroll down and tick **Use branded A6 labels for Express**.
* Click **Save**.
---
# Print four Australia Post labels per page
URL: https://support.starshipit.com/articles/360000313576-print-four-australia-post-labels-per-page
Canonical: https://support.starshipit.com/articles/360000313576-print-four-australia-post-labels-per-page
Markdown: https://support.starshipit.com/articles/360000313576-print-four-australia-post-labels-per-page.md
Updated: 2026-09-09
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Configure and print Australia Post eParcel label sheets with three Express or four Standard labels per A4 page.
Print Australia Post eParcel labels on A4 sheets: three Express labels or four Standard labels per page.
## Before you begin
Set up [Australia Post eParcel](/articles/couriers/australia-post/set-up-australia-post-eparcel-parcel-send) first.
:::note
Automatic Desktop App routing is not supported for Australia Post label sheets. Download the sheet PDF, then print it from your browser or PDF viewer.
:::
## Configure label-sheet printing
1. In [Starshipit](https://app2.starshipit.com/), go to **Settings** > **Couriers**.
2. Open Australia Post **Settings**.
3. Select **Advanced**, then find **Format**.
4. Select **A4 4-per Std & 3-per label Express**.
5. Click **Save**.
## Print label sheets
Choose the method that matches how you print orders.
### Bulk print from the Orders page
Bulk printing downloads a PDF immediately, formatted for the selected Express or Standard labels.
### Add labels to the queue
Printing from an individual order adds its label to the queue. To download the queued sheet:
1. Go to **Orders**, and select the **New** tab.
2. Open the order.
3. Click **Print Labels**. Your label will be added to the queue.
4. Under **Actions**, select **Print AusPost label sheets** from the dropdown menu.
5. Click **Print Express Sheets** or **Print Standard Sheets** to download a PDF with your labels.
## Related information
- [Australia Post eParcel information](https://auspost.com.au/business/shipping/manage-your-shipping/eparcel)
- [Choose a shipping label printer and label size](/articles/360001921655-shipping-label-printers-and-label-sizes)
---
# Configure A6 CN22 labels for Australia Post eParcel
URL: https://support.starshipit.com/articles/360001225675-configure-a6-cn22-labels-for-australia-post-eparcel
Canonical: https://support.starshipit.com/articles/360001225675-configure-a6-cn22-labels-for-australia-post-eparcel
Markdown: https://support.starshipit.com/articles/360001225675-configure-a6-cn22-labels-for-australia-post-eparcel.md
Updated: 2026-05-06
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Learn how to configure print settings for Australia Post eParcel international labels.
* Learn how to configure print settings for Australia Post eParcel international labels, including the A6 (thermal printer size) CN22 label.
* Enable the CN22 label for all international services that Australia Post eParcel allows. Note that this does not include **signed for** services such as **PTI7** (they must still use CN23).
## Configuring print settings for Australia Post
You can set up print settings for different label types.
1. Go to **Settings**, select **Printing**, then select the **Advanced** tab.
2. Click **Add new print settings**.
3. Click on the print settings type that you want to set up for **Australia Post**.
* **AusPost** - for domestic standard + express
* **AusPost Express** - for domestic express (overrides the one above)
* **AusPost International** - for international CN23
* **AusPost International 100x150** - for international CN22
4. Set your **Print Method** e.g. Download PDF, Print Client.
1. Go to **Settings**, select **Printing**, then select the **Advanced** tab.
2. Click **Add new print settings**.
3. Click on the print settings type that you want to set up for **Australia Post**.
* **AusPost** - for domestic standard + express
* **AusPost Express** - for domestic express (overrides the one above)
* **AusPost International** - for international CN23
* **AusPost International 100x150** - for international CN22
4. Set your **Print Method** e.g. Download PDF, Print Client.
## Using A6 international (CN22) for all international products
* With orders of weight less than or equal to 2 kg, the international services available are **AIR8, ECM8, ECD8, PTI8** + **RPI8**.
* With orders of weight more than 2 kg, the international services available are **AIR8** + **ECM8**.
## Enabling A6 (CN22) labels
1. Go to **Settings**, select **Couriers**, then select **Australia Post**.
2. Click the **Advanced** to see additional Australia Post settings.
3. Tick **Use CN22 for all international products.**
If **ticked**:
* **RPI8**, **ECD8** + **PTI8** generate **CN22**
* **AIR8** with order weight *less than or equal to* **2 kg** generates **CN22**, otherwise CN23
* **ECM8** with order weight *less than or equal to***2.55 kg** generates **CN22**, otherwise CN23
*(note that this is an AusPost defect which will be corrected to 2 kg, to align with AIR8)*
If **unticked** (default):
* **ECM8**, **ECD8** + **PTI8** generate **CN23**
* **AIR8** with order weight *less than or equal to***2 kg** generates **CN22**, otherwise CN23
* **RPI8** generates **CN22**
:::important
As well as the 2 kg weight limit mentioned above, there are some other conditions that will automatically switch the generation of the label from CN22 to CN23 - see the criteria below about parcel dimensions, value, and the table detailing product/service code and destination country combinations where the country does not permit CN22. AusPost currently does NOT support foreign characters in CN22 (only in CN23). This is an AusPost limitation, which they are aware of (hopefully they will change this in the future).
:::
## Meeting A6 (CN22) label criteria
You must meet the following criteria to enable an A6 (CN22) label, otherwise the system will default to the A5 (CN23) label.
* Parcel dimensions are *less than or equal to* 90 cm (L + W + D combined)
* The greatest parcel dimension is *less than or equal to* 60 cm
* Total consignment value is *less than or equal to* $500 AUD
* Parcel weight is *less than or equal to* 2 kg
* Parcel delivers to a country that permits the CN22 A6 label (refer to the table below)
## Countries that permit the CN22 A6 label
The following table is from [Australia Post.](https://auspost.com.au/business/shipping/international-shipping/cn22-changes#country)
| Product | Country | Zone |
| --- | --- | --- |
| Express | All except China | 8 |
| Standard without a signature on delivery | Belgium | 8 |
| Canada | 4 |
| Croatia | 8 |
| Denmark | 8 |
| Estonia | 8 |
| France | 7 |
| Germany | 7 |
| Hong Kong | 3 |
| Hungary | 8 |
| India | 3 |
| Ireland | 6 |
| Israel | 9 |
| Japan | 3 |
| Korea, Republic of (Note – Democratic Republic of Korea does not allow the label) | 3 |
| Lithuania | 9 |
| Malaysia | 3 |
| Malta | 8 |
| Netherlands | 7 |
| New Zealand | 1 |
| Philippines | 5 |
| Poland | 8 |
| Portugal | 8 |
| Singapore | 3 |
| Slovenia | 8 |
| Spain | 7 |
| Sweden | 7 |
| Taiwan | 2 |
| Thailand | 3 |
| United States | 4 |
| United Kingdom | 6 |
| Vietnam | 3 |
*Last updated February 2024*
---
# Use one Australia Post eParcel account across multiple Starshipit accounts
URL: https://support.starshipit.com/articles/206296283-use-one-australia-post-eparcel-account-across-multiple-starshipit-accounts
Canonical: https://support.starshipit.com/articles/206296283-use-one-australia-post-eparcel-account-across-multiple-starshipit-accounts
Markdown: https://support.starshipit.com/articles/206296283-use-one-australia-post-eparcel-account-across-multiple-starshipit-accounts.md
Updated: 2026-05-06
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Use one Australia Post eParcel account across multiple Starshipit accounts.
* This article outlines key considerations when using the same Australia Post eParcel API credentials on multiple accounts in Starshipit.
* Starshipit uses the Dispatch ID and Current Increment values in your Australia Post settings to create tracking numbers.
* The Current Increment values must be separated by at least 1,000,000 on each Starshipit account.
* The advice in this article also applies for StarTrack.
## How it works
When generating labels and tracking numbers, Starshipit will use the Dispatch ID (MLID) associated with your Australia Post eParcel account. The Dispatch ID will always prefix any tracking number generated by Australia Post. Immediately following the Dispatch ID in the tracking number is the Current Increment which always goes up by one for each Australia Post eParcel label you print.
The default increment will be 3,400,000, however, if the same Australia Post eParcel API details have been used in multiple Starshipit accounts and a previously used increment is re-used this can result in duplicate tracking numbers. Shipments with duplicate tracking numbers will still be delivered correctly, but two or more sets of tracking events will appear against that tracking number. Starshipit will attempt to alert you with an error when or before this happens.
:::note
For the above reasons we recommend separating the Current Increment value by at least 1,000,000 on each Starshipit account when using the same Australia Post e Parcel API details.
:::
## Change the increment number
1. In Starshipit, navigate to **Settings** > **Couriers**.
2. Click **Settings** next to **Australia Post**.
3. Under **Current Increment** change the increment number by at least **1,000,000**.
4. Click **Set**.
5. Click **Save**.
---
# Set up Australia Post On Demand / StarTrack Courier
URL: https://support.starshipit.com/articles/360000324635-set-up-australia-post-on-demand-startrack-courier
Canonical: https://support.starshipit.com/articles/360000324635-set-up-australia-post-on-demand-startrack-courier
Markdown: https://support.starshipit.com/articles/360000324635-set-up-australia-post-on-demand-startrack-courier.md
Updated: 2026-09-07
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Connect Australia Post On Demand or StarTrack Courier to Starshipit and confirm you can print a label.
Connect Australia Post On Demand or StarTrack Courier to Starshipit, then add the services available on your account.
## Before you begin
Request your **Account No**, **API Key**, and **Password** from the Australia Post Developer Centre. Follow [Generate an Australia Post / StarTrack API key and secret](/articles/couriers/australia-post/generate-an-australia-post-startrack-api-key-and-secret) if you need help getting these details.
## Add Australia Post On Demand to Starshipit
1. Open the [Starshipit web portal](https://app2.starshipit.com/).
2. Go to **Settings** > **Courier** > **Add a new courier** > **AusPost On Demand**.
3. Select **Enable AusPost On Demand**.
4. Enter your **Account No**, **API Key**, and **Password**.
5. Select **Use the API**.
6. Add the service codes your account can use. See [Australia Post On Demand and StarTrack Courier service codes and booking windows](/articles/90200000000167-australia-post-on-demand-and-startrack-courier-service-codes-and-booking-windows).
7. Click **Save**.
## Configure pickups and delivery options
Set a pickup date and time that is valid for the selected service before you print a label. See [Schedule pickups for Australia Post On Demand and StarTrack Courier](/articles/90200000000166-schedule-pickups-for-australia-post-on-demand-and-startrack-courier) for the available scheduling methods, service windows, and what to do when a booking window has closed.
## Verify the setup
1. Create or open a test order that uses one of the service codes you added.
2. Check the pickup date and time are within that service's booking window.
3. Print the label.
4. Confirm the label and tracking number are created, and review the delivery instruction before dispatching the order.
## Troubleshooting
### Tracking has not updated
1. Confirm you printed the shipment with an AusPost On Demand service.
2. Check that the shipment has a tracking number.
3. Allow time for the first carrier scan or event to be returned.
4. Contact Starshipit support with the order number if tracking still does not update.
## Related articles
- [Schedule pickups for Australia Post On Demand and StarTrack Courier](/articles/90200000000166-schedule-pickups-for-australia-post-on-demand-and-startrack-courier)
- [Australia Post On Demand and StarTrack Courier service codes and booking windows](/articles/90200000000167-australia-post-on-demand-and-startrack-courier-service-codes-and-booking-windows)
- [Australia Post's StarTrack Courier service information](https://auspost.com.au/business/shipping/domestic-shipping/startrack-courier)
---
# Schedule pickups for Australia Post On Demand and StarTrack Courier
URL: https://support.starshipit.com/articles/90200000000166-schedule-pickups-for-australia-post-on-demand-and-startrack-courier
Canonical: https://support.starshipit.com/articles/90200000000166-schedule-pickups-for-australia-post-on-demand-and-startrack-courier
Markdown: https://support.starshipit.com/articles/90200000000166-schedule-pickups-for-australia-post-on-demand-and-startrack-courier.md
Updated: 2026-09-07
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Choose a valid pickup date and time for Australia Post On Demand or StarTrack Courier shipments.
Choose a pickup date and time that is valid for your Australia Post On Demand or StarTrack Courier service before you print its label.
## Before you begin
Connect the courier and add your service codes first. See [Set up Australia Post On Demand / StarTrack Courier](/articles/360000324635-set-up-australia-post-on-demand-startrack-courier).
## Choose where to update the pickup
Update the pickup date or time from the **New Order** page when you select a service, or in **Settings** > **Couriers** > **AusPost On Demand**. Both places update the same saved setting.
## Schedule services that need a pickup date
AusPost On Demand **AFT**, **TON**, and **SAT**, plus StarTrack non-Ad hoc services, need a pickup date.
If the saved date has passed, Starshipit uses today, or the next available Saturday for Saturday services. This only works while that service's booking window is open. If the window has closed, change the date to the next valid pickup day before printing.
## Schedule services that need a pickup date and time
AusPost On Demand **NOW** and all StarTrack Ad hoc services need both a pickup date and time.
| Method | How it works |
| --- | --- |
| **Fixed date and time** | Starshipit uses the saved date and time exactly. Update it at least once each day so it is in the future and within the service's booking window. |
| **Offset from printing** | Starshipit schedules the pickup for a set number of minutes after you print or book the label. If that would be before the service window opens, it uses the window start time instead. |
:::tip
Use an offset when you want each pickup scheduled relative to printing. For example, a 30-minute offset schedules a label printed at 14:00 for 14:30.
:::
## Troubleshoot pickup scheduling
### I am outside the booking window
Change the pickup date to the next valid day, then print the label again. The next valid day may not be the next calendar day, such as when the following day is Sunday.
### My offset pickup is outside the service window
If the calculated pickup time is after the service window ends, Starshipit shows an error. Change the pickup date to the next valid day before printing.
### The wrong delivery instruction appears
Open the order and review its delivery options before printing. For TON, confirm whether **Authority to Leave** or **Signature Required** is required.
## Related articles
- [Set up Australia Post On Demand / StarTrack Courier](/articles/360000324635-set-up-australia-post-on-demand-startrack-courier)
- [Australia Post On Demand and StarTrack Courier service codes and booking windows](/articles/90200000000167-australia-post-on-demand-and-startrack-courier-service-codes-and-booking-windows)
---
# Australia Post On Demand and StarTrack Courier service codes and booking windows
URL: https://support.starshipit.com/articles/90200000000167-australia-post-on-demand-and-startrack-courier-service-codes-and-booking-windows
Canonical: https://support.starshipit.com/articles/90200000000167-australia-post-on-demand-and-startrack-courier-service-codes-and-booking-windows
Markdown: https://support.starshipit.com/articles/90200000000167-australia-post-on-demand-and-startrack-courier-service-codes-and-booking-windows.md
Updated: 2026-09-07
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Find Australia Post On Demand and StarTrack Courier service codes, booking windows, pickup windows, and weight limits.
Use this reference to find the service codes, booking windows, pickup windows, and vehicle limits for Australia Post On Demand and StarTrack Courier.
## Before you begin
Add only services enabled on your Australia Post or StarTrack account. Printing a label also books the pickup. If a booking window has closed, select the next available pickup date before printing.
## Australia Post On Demand services
| Code | Service | Booking window | Pickup window |
| --- | --- | --- | --- |
| **NOW** | Now | Monday–Friday until 14:00 | Monday–Friday 08:00–15:00 at the scheduled time, or ad hoc on the same day |
| **AFT** | Afternoon | Monday–Friday until 11:00 | Monday–Friday until 12:00 |
| **TON** | Tonight | Monday–Friday until 15:00 | Monday–Friday until 16:00 |
| **SAT** | Saturday | Saturday until 11:00 | Friday at the nominated time, or Saturday until 12:00 |
## StarTrack 2U2Day services
| Code | Service | Booking window | Pickup window |
| --- | --- | --- | --- |
| **2USD** | SameDay | Monday–Friday until 08:00 | Monday–Friday 08:00–09:00 at the scheduled time |
| **2UPM** | Afternoon | Monday–Friday until 11:00 | Monday–Friday 11:00–12:00 at the scheduled time |
| **2UPBM** | PM (Afternoon) Brisbane Multi-piece | Same as 2UPM | Usually the same as 2UPM |
| **2UTW** | Twilight | Monday–Friday until 15:00 | Monday–Friday 15:00–16:00 at the scheduled time |
| **2USA** | Saturday | Saturday until 11:00 | Saturday 11:00–12:00 at the scheduled time |
## StarTrack Ad hoc services
| Codes | Vehicle or service | Weight limit | Booking window | Pickup window |
| --- | --- | ---: | --- | --- |
| **STC**, **STW**, **STH**, **STV** | Standard Courier, Wagon, Half Tonne Van, Full Tonne Van | 25 kg, 125 kg, 500 kg, 1 tonne | Monday–Friday until 16:00 | Monday–Friday 08:00–16:00 |
| **EXTC**, **EXTW**, **EXTH**, **EXTV** | Express Courier, Wagon, Half Tonne Van, Full Tonne Van | 25 kg, 125 kg, 500 kg, 1 tonne | Monday–Friday until 17:00 | Monday–Friday 08:00–17:00 |
| **IMTC**, **IMTW**, **IMTH**, **IMTV** | Immediate Priority Courier, Wagon, Half Tonne Van, Full Tonne Van | 25 kg, 125 kg, 500 kg, 1 tonne | Monday–Friday until 18:00 | Monday–Friday 08:00–18:00 |
## Additional settings reference
| Setting | What it controls |
| --- | --- |
| **Integration** | Whether the API integration is used for labels and manifests. |
| **Enable Email Tracking** | Whether tracking notifications are sent through the courier integration. |
| **Disable ATL** | Prevents authority to leave from being applied. |
| **Current increment** and **Client code** | Identifiers used when creating consignments. |
| **Pickup** | Schedules a pickup immediately, after an offset, or at a specified date and time. Afternoon and tonight presets are also available. |
| **Delivery type** | Selects the delivery type returned for the shipment. |
## B2B2C shipments with missing SKUs
Some Australia Post B2B2C shipment flows require an SKU for every item. Add missing SKUs to your source order or product catalogue, re-import the order, and confirm they appear on the order line items before printing.
## Related articles
- [Set up Australia Post On Demand / StarTrack Courier](/articles/360000324635-set-up-australia-post-on-demand-startrack-courier)
- [Schedule pickups for Australia Post On Demand and StarTrack Courier](/articles/90200000000166-schedule-pickups-for-australia-post-on-demand-and-startrack-courier)
---
# Set up Bascik
URL: https://support.starshipit.com/articles/90200000000115-set-up-bascik
Canonical: https://support.starshipit.com/articles/90200000000115-set-up-bascik
Markdown: https://support.starshipit.com/articles/90200000000115-set-up-bascik.md
Updated: 2026-08-03
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Connect Bascik to create New Zealand domestic bulky freight labels, show rates, and track shipments.
Connect Bascik to Starshipit to create New Zealand domestic bulky freight labels, show live rates, and track shipments. This guide explains what you need from Bascik and how to add the courier to your Starshipit account.
## Before you begin
To connect Bascik to Starshipit, you need:
* Bascik account ID
* Webnotes API username
* Webnotes API password
* Contracted Bascik product codes and default goods type
* Connote prefix, if Bascik gave you one
If you do not have these details, contact your Bascik account manager.
## Set up Bascik in Starshipit
1. In Starshipit, go to **Settings** > **Couriers** > **Add a new courier**.
2. Select **New Zealand** as the shipping from country.
3. Select **Bascik**.
4. Tick **Enable Bascik**.
5. Enter your **Account ID**, **Username**, and **Password**.
6. Enter the **Default Goods Type** for your Bascik account, such as Item, Pallet, or Carton.
7. Enter a **Connote Prefix** if Bascik supplied one. If you do not enter a prefix, Starshipit uses `SSI`.
8. Under **Add Product Codes**, add the Bascik product codes included in your contract, for example `F` (Freight).
9. Click **Save**.
Your Bascik integration is now connected. You can verify the setup by creating a test shipment.
## Limitations
* Bascik supports domestic shipments within New Zealand.
* International shipping and returns are not supported through this integration.
* Bascik labels print as 100 x 150 mm PDF labels.
* A separate manifest step is not required.
* Bascik supports up to six goods rows per consignment. Starshipit maps one goods row per package.
## Configure Bascik settings
Use the following fields on the **Settings** tab:
| Setting | What to enter or choose |
| --- | --- |
In **Product codes**, add the Bascik rate products you want returned in Starshipit. Product-code settings affect rates; **Default Goods Type** affects shipment creation.
## Troubleshooting
**No rates are showing?**
Check that:
* The order is a New Zealand domestic shipment.
* Your Bascik credentials are correct.
* The sender and receiver address details are complete.
* The account has a Bascik rate table for the destination.
* Product codes match the Bascik configuration for your account.
**Labels are not generating?**
Check that Bascik is enabled, the required address and contact fields are complete, and package or goods details are entered.
**Tracking is not updating?**
Bascik tracking uses the tracking number returned when the shipment is booked. You can also track a Bascik shipment at `https://online.bascik.co.nz/Public/Track/?id={trackingNumber}`.
---
# Bonds Courier
URL: https://support.starshipit.com/articles/11733908000655-bonds-courier
Canonical: https://support.starshipit.com/articles/11733908000655-bonds-courier
Markdown: https://support.starshipit.com/articles/11733908000655-bonds-courier.md
Updated: 2026-05-06
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Ship domestically in Australia with Bonds Courier and access all Starshipit features including label generation, tracking, and notifications.
Bonds Courier allows you to ship domestically in Australia and use all of [Starshipit's features](https://www.starshipit.com/features) including generation of packing slips and shipping labels, auto-correction of addresses, branded tracking and notifications, and many more.
## What you need to get started
To integrate Bonds Courier, you will need the following:
* **Account number**: Provided by Bonds Courier.
* **Authorisation code**: Obtain this from Bonds Courier.
* **Branch code**: Specific to your location and account.
## How to set up Bonds
To enable Bonds on your [Starshipit](https://app2.starshipit.com/) account:
1. Navigate to **Settings** > **Couriers** > **Add New Courier** > **Bonds Courier.**
2. Select**Enable Bonds Couriers.**
3. Enter in your **Account, Authorisation Code** and **Branch Code**
4. Click Save.
You will then need to set up your product codes. To add a product code:
1. Navigate to **Settings** > **Couriers** > **Add New Courier** > **Bonds.**
2. From the product codes section select a product from the drop down
3. Click **Add.**
## Available products
| | |
| --- | --- |
| Product Number | Product Description |
| 1 | Small Parcels/Boxes |
| 2 | Station Wagon |
| 3 | Small Van to 250 kg |
| 4 | 1 Tonne Van |
| 5 | Small Tray to 500 kg |
| 6 | 1 Tonne Open Tray |
| 7 | 2 Tonne Van |
| 8 | 2 Tonne Open-Tray |
| 9 | 4 Tonne Tautliner |
| 10 | 3 Pallet Van |
| 11 | 4 Tonne Open Tray |
| 12 | 6 Tonne Tautliner |
| 13 | 6 Tonne Open Tray |
| 14 | 8 Tonne Tautliner |
| 15 | 8 Tonne Open Tray |
| 16 | 12 Tonne Tautliner |
| 17 | 12 Tonne Open Tray |
| 18 | 14 tonne Tautliner |
| 19 | 14 tonne Open Tray |
| 20 | Semi Trailer |
You can add more than one product code and mark one as **Default**. Save the settings after changing credentials or product codes.
---
# Set up Border Express
URL: https://support.starshipit.com/articles/360002156835-set-up-border-express
Canonical: https://support.starshipit.com/articles/360002156835-set-up-border-express
Markdown: https://support.starshipit.com/articles/360002156835-set-up-border-express.md
Updated: 2026-05-06
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Step-by-step guide to setting up Border Express.
## Before you begin
If you don't already have an account please reach out to the Border Express sales team, click [here](https://www.borderexpress.com.au/get-started/).
To set up Border Express you need your:
* Paying Account Code (Account Number)
* Consignment Prefix
* Client ID
* Client Secret
If you are missing any of these credentials, please contact [Border Express](mailto:integrations@borderexpress.com.au) with your Paying Account Code. You should then receive:
* An email confirming that your request has been submitted. You will receive your **Consignment Prefix** in this email.
* A subsequent email will be sent requesting you to generate your API credentials by clicking the activation link within the email.
* The activation link will redirect you to the Border Express website which will display your **Client ID** and **Client Secret**.
## Setting up your Border Express account in Starshipit
### 1. Enter your Border Express credentials in Starshipit
1. Go to **Settings** > **Couriers** > **Add Courier** > **Border Express**.
2. Check the **Enable Border Express** checkbox.
3. Fill in your Client ID, Client Secret, Paying Account Code, and Consignment Prefix
4. Click **Save**.
### 2. Set up your product codes
To complete the integration between Starshipit and Border Express, you need to add your product codes.
1. Go to **Settings** > **Couriers** > **Add Courier** > **Border Express**.
2. Click on **Add product code**.
3. Enter the product code and the product name.
4. Click **Save**.
5. Repeat 1-4 for each product code you would like to add.
The available product codes are:
| | | |
| --- | --- | --- |
| **Code** | **Name** | **Description** |
| PAR | Parcel | Parcel or carton freight, typically a B2B service. |
| BLK | Bulk | Bulk palletised freight. |
| ECM | eCommerce (single piece) | B2C individual items only. |
| MEC | eCommerce (multi piece) | B2C multiple items. |
### Border Express Additional Features
Residential Surcharge: The residential surcharge can be enabled as a default setting in your Starshipit account. Enabling this setting will apply the residential surcharge to all of your Border Express rates. Please note, the amount billed can vary and is determined by Border Express when they have received the shipment details and regard the address as residential. For more information on how Border Express determines the residential surcharge please reach out to your Border Express account manager.
### Dangerous goods
Starshipit supports sending dangerous goods with Border Express. Before you start shipping dangerous goods, confirm with Border Express that your account is approved for dangerous goods freight, then add your dangerous goods details in Starshipit.
See [Border Express Dangerous Goods](/articles/couriers/border-express/border-express-dangerous-goods) for setup steps.
## Configure Border Express settings
These settings are organised into **Settings**, **Delivery Options**, and **Advanced**:
| Setting | What it controls |
| --- | --- |
| **Use Staging URL** | Uses the test endpoint. Leave this off for live shipments. |
| **Add Reference field to labels** | Adds the order reference after the order number on the label. |
| **Display transit times** | Shows transit-time information at checkout. |
| **Delivery Service Description** | The text shown for the service at checkout. |
| **Authority to leave** | Defaults authority to leave for Border Express shipments. |
| **Enable Residential Charge in rates request** | Includes the residential surcharge when requesting rates. |
| **Display SKU on labels** | Prints item SKUs on labels. |
For dangerous goods, add the **Dangerous Goods Contact Name** and **Dangerous Goods Contact Phone**, then configure each entry with its default flag, UN number, shipping name, class, sub-risk, packing group, package type, quantity, and aggregate quantity. Add the Border Express product codes your account supports.
### Other relevant information for you
To learn more about the benefits of the partnership between Border Express and Starshipit for your eCommerce business, [click here](https://www.starshipit.com/blog-content/border-express-starshipit-partner-for-ecommerce-success)
---
# Border Express Dangerous Goods
URL: https://support.starshipit.com/articles/90200000000117-border-express-dangerous-goods
Canonical: https://support.starshipit.com/articles/90200000000117-border-express-dangerous-goods
Markdown: https://support.starshipit.com/articles/90200000000117-border-express-dangerous-goods.md
Updated: 2026-06-15
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Set up dangerous goods for Border Express shipments in Starshipit.
Starshipit supports sending dangerous goods with Border Express. Before you ship dangerous goods, confirm with Border Express that your account is approved for dangerous goods freight.
You can apply dangerous goods manually on an order, or use rules to apply a dangerous goods type automatically.
## Before you begin
To set up dangerous goods for Border Express, you need:
* Approval from Border Express to send dangerous goods.
* Dangerous goods contact name and phone number.
* Dangerous goods details for each type you want to use, including:
* UN number
* Shipping name
* Class
* Sub-risk, if required
* Packing group
* Package type
* Quantity
* Aggregate quantity
If you are unsure which details apply to your products, check your Safety Data Sheet or contact your Border Express account manager.
:::note
Some UN numbers can apply to more than one dangerous goods classification. For example, aerosols under `UN1950` may need extra details such as shipping name, class, and sub-risk so Border Express can identify the goods correctly.
:::
## Add dangerous goods details
1. In Starshipit, go to **Settings** > **Couriers** > **Border Express**.
2. Open the **Dangerous Goods** tab.
3. Enter the dangerous goods contact name and phone number.
4. Add a dangerous goods entry for each dangerous goods type you want to ship.
5. Mark one entry as the default if you want Starshipit to use it when an order is flagged as dangerous goods but no specific type is selected.
6. Click **Save**.
## Apply dangerous goods to an order
You can apply dangerous goods to an order manually from the order details page.
If you select a specific dangerous goods type, Starshipit sends the matching dangerous goods entry to Border Express when the shipment is printed. If you only flag the order as dangerous goods, Starshipit uses the default dangerous goods entry from your Border Express settings.
## Apply dangerous goods using rules
Once you have added dangerous goods entries in your Border Express settings, you can use rules to apply them automatically.
1. In Starshipit, go to **Settings** > **Rules**.
2. Click **Add a new rule**.
3. Add the conditions that identify the dangerous goods orders, such as item SKU.
4. Select the action **Set Dangerous Goods Type**.
5. Select or enter the UN number for the dangerous goods entry you have set up.
6. Click **Save**.
Any rule that references a dangerous goods type that has not been set up in your Border Express settings will be ignored.
## Dangerous goods rates and declaration
When an order is flagged as dangerous goods, Starshipit sends the dangerous goods flag when getting Border Express rates and when creating the shipment.
When printing labels, Starshipit uses the dangerous goods details saved in your Border Express settings to populate the dangerous goods declaration information, including shipping name, class, sub-risk, packing group, package type, quantity, aggregate quantity, and dangerous goods contact phone number.
---
# Set up Canada Post
URL: https://support.starshipit.com/articles/13017482447119-set-up-canada-post
Canonical: https://support.starshipit.com/articles/13017482447119-set-up-canada-post
Markdown: https://support.starshipit.com/articles/13017482447119-set-up-canada-post.md
Updated: 2026-05-06
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Step-by-step guide to setting up Canada Post.
Canada Post is the primary postal operator in Canada, offering a broad network for domestic deliveries across the country. Starshipit's integration with Canada Post supports domestic shipments within Canada for commercial customers who have a valid parcel agreement. Starshipit's integration with Canada Post allows you to use all of [Starshipit's features](https://www.starshipit.com/features) including generation of packing slips and shipping labels, auto-correction of addresses, branded tracking, and notifications and many more. This article outlines how to set up and use Canada Post as a courier service in Starshipit.
## Before you begin
To set up Canada Post you need your:
* Canada Post Account Number
* Contract ID
* API Username
* API Password
* Shipping Point ID
You can look up your Shipping Point ID using Canada Post's [Find a Deposit Location](https://www.canadapost-postescanada.ca/information/app/fdl/business/findDepositLocation) tool.
If you are missing any of these credentials, please contact your Canada Post account manager or visit [Canada Post](https://www.canadapost-postescanada.ca).
Note: You must be a Canada Post commercial customer with a parcel agreement. If you are a commercial customer but do not yet have a parcel agreement, please contact your Canada Post sales representative or call Canada Post at 1-866-757-5480
## Setting up your Canada Post account in Starshipit
### 1. Enter your Canada Post credentials in Starshipit
1. Go to **Settings** > **Couriers** > **Add Courier** > **Canada Post**.
2. Check the **Enable Canada Post** checkbox.
3. Enter your Account Number and Contract ID.
4. Enter your **API Username** and **API Password**.
5. Select **Requested Shipping Point** and enter the dispatch postcode, or select **Shipping Point ID** and enter the facility number.
6. Select **Use Development Environment** only when testing with Canada Post.
7. Click **Save**.
### 2. Configure dispatch method
You can define how your shipments are dispatched using one of the two methods supported by Canada Post:
* **Requested Shipping Point**: Uses a Canadian postcode as the dispatch point.
* **Shipping Point ID**: Uses a Canada Post office location ID for drop-off.
Both methods are equivalent in the Canada Post system and can be selected based on your fulfilment process.
### Available services and features
Supported add ons: Only **Signature Required is** currently supported.
Rate calculation: Starshipit retrieves rates for valid Canadian address pairs using your Canada Post credentials.
Manifesting: Starshipit currently assigns each shipment to it's own manifest. If you have more than 30 orders to manifest, you will need to generate multiple manifests manually. Charges are applied by Canada Post at the time of manifest creation.
Add the product codes available on your Canada Post account and mark the service you want to use by default.
---
# Set up Capital Transport
URL: https://support.starshipit.com/articles/90200000000105-set-up-capital-transport
Canonical: https://support.starshipit.com/articles/90200000000105-set-up-capital-transport
Markdown: https://support.starshipit.com/articles/90200000000105-set-up-capital-transport.md
Updated: 2026-05-25
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Connect Capital Transport to create Australian domestic labels, show live rates, and track shipments.
Connect Capital Transport to Starshipit to create Australian domestic labels, show live rates, and track shipments. This guide explains what you need from Capital Transport and how to add the courier to your Starshipit account.
## Before you begin
To connect Capital Transport to Starshipit, you need these details from Capital Transport:
* Username
* Shared key
* API key
* Account code
* State ID
* Product or service codes
If you do not have these details, contact your Capital Transport account manager. You can also visit the [Capital Transport website](https://capitaltransport.com.au/).
## Set up Capital Transport in Starshipit
1. In Starshipit, go to **Settings** > **Couriers** > **Add a new courier**.
2. Select **Australia** as the shipping from country.
3. Select **Capital Transport**.
4. Tick **Enable Capital Transport**.
5. Enter your **Username**, **Shared key**, **API key**, **Account code**, and **State ID**.
6. If Capital Transport gave you UAT credentials, tick **Use UAT**.
7. Click **Save**.
Your Capital Transport integration is now connected. You can verify the setup by creating a test shipment.
## Add product codes
Capital Transport requires a product or service code when creating labels. Add the service codes supplied by Capital Transport in the **Add Product Codes** area.
If no service code is available on the shipment, Starshipit cannot create the label.
## Limitations
* Capital Transport supports domestic shipments from Australia.
* International shipping and returns are not supported through this integration.
* Capital Transport labels print as 100 x 150 mm labels.
Add the product codes enabled on your Capital Transport account before creating shipments.
## Troubleshooting
**No rates are showing?**
Check that:
* The order is an Australian domestic shipment.
* The account code and State ID are correct.
* Sender and receiver postcodes are complete.
* Package details are complete.
* The selected service code is configured as a product code in Starshipit.
* Your account is using the correct UAT or live setting.
**Labels are not generating?**
Check that Capital Transport is enabled, your credentials are correct, and the selected service code is available on your account.
---
# Set up Castle Parcels
URL: https://support.starshipit.com/articles/4406125209487-set-up-castle-parcels
Canonical: https://support.starshipit.com/articles/4406125209487-set-up-castle-parcels
Markdown: https://support.starshipit.com/articles/4406125209487-set-up-castle-parcels.md
Updated: 2026-02-05
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Step-by-step guide to setting up Castle Parcels.
Castle Parcels is now integrated with Starshipit in New Zealand. Castle Parcels offer an Express economy nation-wide courier service with tailor-made solutions for specific industries throughout New Zealand. Through alliances with other Freightways Group companies, Castle Parcels delivers a complete package offer. This integration allows you to use all of [Starshipit's features](https://www.starshipit.com/features) including generation of packing slips and shipping labels, auto-correction of addresses, branded tracking and notifications and many more.
## Before you begin
To integrate with Castle Parcels you'll need to have your Castle Parcels Account Number, Client ID and Client Secret available.
If you don't have these credentials please contact your Castle Parcels account manager or [contact Castle Parcels via email or phone](https://www.castleparcels.co.nz/contact_us.html).
## Enable Castle Parcels in Starshipit
To enable Castle Parcels as a courier in New Zealand:
1. Navigate to **Settings** > **Couriers** > click **Add a new****courier**.
2. Click Castle Parcels from the list of couriers.
3. Tick **Enable Castle Parcels**.
4. Enter your Castle Parcels **Account Number, Client ID and Client Secret.**
5. Click **Save.**
Once you've entered and saved these details click **Test to ensure it works** to confirm that your integration is correctly set up.
## Available product codes with Castle Parcels
NZ Couriers via Starshipit can be set up with two different product code types:
**Overnight Delivery**
Overnight is the standard service offering for Castle Parcels. It can be used anywhere in New Zealand as long as NZ Couriers offers pickups and deliveries in that area.
**Two Day Delivery**
Two Day delivery is offered as an economy service for inter-island shipments. This means in Starshipit you will only see pricing for Two Day, if you have pricing loaded on your Castle Parcels account, and the shipment is inter-island (e.g. sending from Auckland to Christchurch)
## Add your product codes
Finally, add the product codes you'd like to use for Castle Parcels by going to:
1. **Add product codes** section > Click **Add a new product code**.
2. Enter the **Code** and **Name** for the product code.
3. If the product code should be your default, tick the **Default** checkbox.
4. Click **Save**.
## Advanced settings
If required you can also update your Advanced Settings for Castle Parcels.
The available Advanced Settings are:
* **Signature Required:** Select this option to default 'Signature Required' on all orders.
* **Saturday Delivery:** Select this option to default 'Saturday Delivery' on all orders.
* **Send Notifications:** To automatically send notifications for every order, enable the "Send Notifications" option. When dispatching orders, ensure the "Send Notifications" checkbox is selected. The default state of this option is determined by your settings preference.
* **Notifications Type:** When send notifications is ticked, what type of notifications should be sent? Note that Freightways may incur additional charges for SMS notifications.
## Configure Castle Parcels settings
In addition to the credentials and defaults above, Castle Parcels provides:
| Setting | What it controls |
| --- | --- |
| **Format for outbound labels** | Sets the paper size and layout Starshipit uses for labels on customer deliveries. Choose the option that matches your printer. |
| **Format for return labels** | Sets the paper size and layout for labels included with return shipments. Choose the option that matches your printer. |
| **Signature Required** | Adds signature-required delivery to eligible shipments by default. |
| **Saturday Delivery** | Requests Saturday delivery by default when the selected service supports it. |
| **Send Notifications** | Requests Castle Parcels tracking notifications for shipments created in Starshipit. |
| **Notification Type** | Sets whether the receiver is notified by email or SMS. Freightways may charge for SMS notifications. |
| **Mixed Packaging** | Lets one shipment include different package types when Castle Parcels supports it. |
| **Validate Receiver Address** | Checks the receiver's delivery address before it is sent for booking, so you can correct problems before a label is created. |
These options are saved with the Castle Parcels courier settings. Check the label and notification result on a test shipment before enabling defaults for all orders.
---
# Set up CouriersPlease
URL: https://support.starshipit.com/articles/204055239-set-up-couriersplease
Canonical: https://support.starshipit.com/articles/204055239-set-up-couriersplease
Markdown: https://support.starshipit.com/articles/204055239-set-up-couriersplease.md
Updated: 2026-05-18
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Step-by-step guide to setting up CouriersPlease.
CouriersPlease's [integration with Starshipit](https://www.starshipit.com/partner/couriersplease) allows you to use all of [Starshipit's features](https://www.starshipit.com/features) including generation of packing slips and shipping labels, auto-correction of addresses, branded tracking and notifications and many more.
## Before you begin
To integrate CouriersPlease with your Starshipit account, you need to have an EDI (Electronic Data Interchange) account. If you don't have one, simply contact your CouriersPlease account manager.
To complete the setup steps, you will need:
* CouriersPlease account number (9 digits)
* Dispatch ID
* Product codes associated with your CouriersPlease account.
* API Key (optional - used for booking pickups and creating returns. Without one, a pickup is booked on manifest)
If you are missing any of these values, please contact your CouriersPlease account manager or contact [Starshipit support.](https://help.starshipit.com)
## Manifests and NDF
CouriersPlease will apply No Data Fee charges (NDF) per consignment when a parcel is picked up prior to being manifested. Because pickup times can change day to day, a fixed auto manifest time (for example, 6:00 pm) may run too late for same-day collections.
To prevent NDF charges being incurred by CouriersPlease, they require releasing the manifest 30 minutes prior to pickup or from the time of pickup. Here's what we recommend:
* **Disabling auto manifest for CouriersPlease.**
*Under Settings > Couriers > Auto manifest > Ensure that CouriersPlease is unticked from the list of couriers.*
* **Manually releasing the manifest when the freight is ready for collection.**
## Setting up your CouriersPlease account in Starshipit
### 1. Enter your CouriersPlease information
1. Navigate to **Settings** > **Couriers** > **Add New Courier** > **CouriersPlease**.
2. Tick **Enable CouriersPlease**.
3. Complete the **Account No** and **Dispatch ID** fields.
4. Enter the **API Key** if you want to book pickups or create returns.
5. Set the increment value to 1. If you have used CouriersPlease with Starshipit in the past, set it to 1,000,000 or above to avoid overlapping with past orders.
6. Click **Save**.
### 2. Enter your product codes
CouriersPlease will provide different product codes based on your requirements and account eligibility. Product codes for shipments need to be populated similar to the following, and these products will then be available throughout Starshipit.
CouriersPlease also supports product code **AC2** for multi-package shipments where enabled on your account.
1. Navigate to **Settings** > **Couriers** > **CouriersPlease**.
2. Click on **Add Product Codes**.
3. Enter the Code and Name.
4. Click **Save**.
### 3. Enabling Returns (optional)
1. Ensure you have added an API key to your settings.
2. Enter in the Return Product Codes in **Settings** > **Couriers** > **CouriersPlease** > **Add return product codes**.
## Troubleshooting
#### Why are the rates displayed in Starshipit incorrect?
Rates are retrieved, based on the product codes. Check with CouriersPlease that the product codes you are using are correct.
#### How can I add Fuel Surcharges to my CouriersPlease rates?
CouriersPlease only applies a Standard fuel levy to Road Express if they
are **not** “Local”
(i.e. passed onto an agent to deliver instead of CouriersPlease delivering)
– currently set at 28.6%.
Starshipit does not require an API key to see this included in the freight
breakdown.
Standard fuel levy is not applied to Satchels (Items).
Extra Ordinary Fuel Surcharge (10%) is **not** included
on the CouriersPlease API.
#### Why are duplicate tracking numbers being generated for different orders?
This is likely due to an overlap in your current consignment increment value.
Navigate to **Settings** > **Couriers** > **CouriersPlease Settings** > Set the **Current Consignment Increment** to a value much higher than the one set currently e.g. 1,000,000.
#### How should I set up CouriersPlease on child accounts?
If you use the same CouriersPlease account across child accounts, increase the **Current Consignment Increment** by at least 500,000 for each child account. This helps prevent duplicate consignment numbers being generated across accounts.
Add the required product codes and mark one as **Default** when Authority to Leave needs a default service.
Learn more about ecommerce shipping services by CouriersPlease [here](https://www.couriersplease.com.au/services-ecomm).
---
# CouriersPlease: Dangerous Goods
URL: https://support.starshipit.com/articles/10309858950031-couriersplease-dangerous-goods
Canonical: https://support.starshipit.com/articles/10309858950031-couriersplease-dangerous-goods
Markdown: https://support.starshipit.com/articles/10309858950031-couriersplease-dangerous-goods.md
Updated: 2026-05-06
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Learn how to ship dangerous goods with CouriersPlease using the CPL-DGS tag in Starshipit.
Starshipit supports sending dangerous goods with CouriersPlease. Prior to shipping, you'll need to get approval from CouriersPlease to ship dangerous goods. You can set which orders contain dangerous goods using the tag CPL-DGS. This tag can be set on your orders manually, via rules or the API. You will need to attach a Dangerous Goods Safety Data Sheet to your shipment. At this point, Starshipit does not support generating Dangerous Goods documentation for CouriersPlease.
:::warning
Before sending dangerous goods, you must obtain approval from CouriersPlease.
:::
### Adding the CPL-DGS tag in Starshipit
To ship dangerous goods with CouriersPlease all you need to do is tag your order with CPL-DGS. To do this, you’ll need to set up the tag in your Starshipit settings.
Navigate to **Settings** > **Tags** > **Add new** > Enter **CPL-DGS** then click **Add**.
You can now apply this tag to orders containing Dangerous Goods. There are multiple ways to apply this tag to an order, you can do so manually in the orders grid, with the use of a rule or via the API.
### Assigning tags to an order
Before you get started you will need to enable the tags column on the orders grid.
In the Orders grid, click the Plus in the tags column. From here you can add the CPL-DGS tag and then click apply.
You can bulk assign tags from the orders grid by selecting all the orders you want to update, selecting Add or Remove Tags from the action menu, and then entering (or removing) the tags you'd like to apply.
You can also apply tags within individual orders. When you open the order, in the bottom right you will see a section for tags where you can add or remove any tags.
You can assign tags to an order via rules. Check out our guide [here](/articles/notifications-branded-tracking-rules-child-accounts/business-rules/rules-overview).
You can also assign tags to an order via the API. Head to our [Developer Center](/developers) to learn more.
### Additional Information
* Starshipit does not support generating Dangerous Goods documentation for CouriersPlease at this time.
* Starshipit does not support Dangerous Goods surcharges on CouriersPlease rates.
---
# Troubleshooting live rates at checkout for CouriersPlease
URL: https://support.starshipit.com/articles/360000092135-troubleshooting-live-rates-at-checkout-for-couriersplease
Canonical: https://support.starshipit.com/articles/360000092135-troubleshooting-live-rates-at-checkout-for-couriersplease
Markdown: https://support.starshipit.com/articles/360000092135-troubleshooting-live-rates-at-checkout-for-couriersplease.md
Updated: 2026-05-06
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Learn how to troubleshoot and resolve common issues with live rates at checkout for CouriersPlease.
This article outlines some of the common errors you could experience around live rates at checkout for CouriersPlease. Read more information about how to integrate with CouriersPlease [here](/articles/couriers/couriersplease/how-to-set-up-couriersplease).
## Error: I can't see my CouriersPlease rates at checkout
Enable defaults in CouriersPlease settings
* In Starshipit, navigate to **Settings** > **Couriers** > **CouriersPlease**.
* Select **Edit** to tick the default product you wish to display at checkout.
---
# Set up Deliver Direct
URL: https://support.starshipit.com/articles/90200000000109-set-up-deliver-direct
Canonical: https://support.starshipit.com/articles/90200000000109-set-up-deliver-direct
Markdown: https://support.starshipit.com/articles/90200000000109-set-up-deliver-direct.md
Updated: 2026-05-25
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Connect Deliver Direct to create United States domestic labels, show live rates, and track shipments.
Connect Deliver Direct to Starshipit to create United States domestic labels, show live rates, and track shipments. This guide explains what you need from Deliver Direct and how to add the courier to your Starshipit account.
## Before you begin
To connect Deliver Direct to Starshipit, you need:
* API code
* API base URL, if you are not using the default
* Shipper primary ID
* Shipper account
* Shipper street, city, state, post code, and country ID
* Default service type, if required
* Payment mode, if different from the default
* Product or service codes supplied for your account
If you do not have these details, contact your Deliver Direct or SmartKargo account manager.
## Set up Deliver Direct in Starshipit
1. In Starshipit, go to **Settings** > **Couriers** > **Add a new courier**.
2. Select **United States** as the shipping from country.
3. Select **Deliver Direct**.
4. Tick **Enable Deliver Direct**.
5. Enter your **API code** and **Base URL** if supplied.
6. Enter your **Shipper primary ID** and **Shipper account**.
7. Enter the shipper address details.
8. Enter a **Default service type** and **Payment mode** if supplied.
9. Click **Save**.
Your Deliver Direct integration is now connected. You can verify the setup by creating a test shipment.
## Add product codes
Deliver Direct uses service types as Starshipit product codes. Add the service types supplied for your account in the **Add Product Codes** area.
If product codes are configured and Deliver Direct does not return one of those service types, rates or labels can fail.
Keep the origin address and service type aligned with the details on your Deliver Direct account.
## Limitations
* Deliver Direct supports domestic shipments within the United States.
* International shipping and returns are not supported through this integration.
* Deliver Direct supports 100 x 150 mm and A4 label sizes.
* Signature required, authority to leave, contract rates, and insurance are supported.
* A separate manifest step is not required.
## Troubleshooting
**No rates are showing?**
Check that:
* The order is a United States domestic shipment.
* API code, shipper primary ID, and shipper account are correct.
* Shipper address fields are complete.
* Base URL and payment mode are correct.
* Package details are complete.
* Product codes match services enabled on your Deliver Direct account.
**Labels are not generating?**
Check that Deliver Direct is enabled, the shipper address fields are complete, and the selected service type is available for the shipment.
**Tracking is not updating?**
Check that the shipment has a tracking number. If tracking still does not update, contact Starshipit support with the tracking number.
---
# Set up Deliver In Person
URL: https://support.starshipit.com/articles/10261593471503-set-up-deliver-in-person
Canonical: https://support.starshipit.com/articles/10261593471503-set-up-deliver-in-person
Markdown: https://support.starshipit.com/articles/10261593471503-set-up-deliver-in-person.md
Updated: 2026-05-06
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Step-by-step guide to setting up Deliver In Person.
Starshipit is now integrated with Deliver In Person in Australia. Deliver In Person offers same-day and next-day delivery solutions within the metro areas of Brisbane, Melbourne, and Sydney. It is available as a domestic courier option when shipping from Australia. [Learn more about our integration with Deliver In Person](https://starshipit.com/partner/deliver-in-person).
## Before you begin
To integrate Deliver In Person with your Starshipit account, you need a Deliver In Person account. If you don't have one, contact your Deliver In Person account manager.
To complete the setup steps, you will need:
* Your Deliver In Person email address and password
* Warehouse ID (i.e., representing the location from which you fullfill your deliveries)
* Product codes associated with your Deliver In Person account
If you do not have these credentials, you can:
* Contact [hello@deliverinperson.com](mailto:hello@deliverinperson.com).
* Visit the [Deliver In Person website](https://deliverinperson.com/senders/).
* Reach out to your Deliver In Person account manager.
* Contact our [Starshipit support team](https://help.starshipit.com).
## Setting up your Deliver In Person account
1. In Starshipit, navigate to **Settings** > **Couriers** > **Add a new courier**.
2. Set the shipping from country as **Australia**.
3. Select **Deliver In Person.**
4. Tick **Enable Deliver In Person**.
5. Enter your Deliver In Person **email address** and **password**.
6. Enter the **Warehouse ID**.
7. Click **Save**.
## Add your product codes
Finally, add the product codes you'd like to use for Deliver In Person by going to:
1. Add product codes section
2. Select a product code from the 'Add New Product Code' list
3. Click Add to save
4. If the product code should be your default, tick the Default checkbox
## Other relevant information for you
Learn more about eCommerce shipping services by Deliver In Person [here](https://deliverinperson.com/senders/).
Add the product codes associated with your Deliver In Person account in **Product codes**. Each product code can have a description and a default flag.
---
# Set up Deutsche Post
URL: https://support.starshipit.com/articles/360001040855-set-up-deutsche-post
Canonical: https://support.starshipit.com/articles/360001040855-set-up-deutsche-post
Markdown: https://support.starshipit.com/articles/360001040855-set-up-deutsche-post.md
Updated: 2026-05-06
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Step-by-step guide to setting up Deutsche Post.
Deutsche Post’s [integration with Starshipit](https://www.starshipit.com/partner/deutsche-post) allows you to use all of [Starshipit's features](https://www.starshipit.com/features) including generation of packing slips and shipping labels, auto-correction of addresses, branded tracking and notifications and many more.
## Before you begin
You need your:
* Account Number (EKP)
If you are missing your EKP number, please contact your Deutsche Post account manager to request it.
Deutsche Post needs to provide additional permissions for your account to be able to use Starshipit, so please ask us to contact them about this, passing us your EKP number.
Otherwise, you can contact Deutsche Post yourself, quoting your EKP number and asking them to add the permissions for Starshipit use with it.
:::note
*If you are using **Global Mail** you can now set up DHL Express Global Mail as a separate courier. Check out the set up instructions [here.](/articles/couriers/deutsche-post/how-to-set-up-dhl-express-global-mail)*
:::
**Customs Forms Signature:** When Deutsche Post set you up, you can upload to their portal a signature to be digitally applied to CN22/CN23 customs forms. This will be used by Deutsche Post (instead of the Starshipit digital signature that you can set up for use with other couriers). [Download the form to sign and upload.](/uploads/attachments/guides/signature-form-for-use-with-po-box-form.pdf)
## Setting up your Deutsche Post in Starshipit
### 1. Enter your account details in Starshipit
:::tip
Click **Test to ensure it works** to check if your credentials are working correctly.
:::
### 2. Set up your product codes
Add your product codes to complete the integration. The selected option determines both the product code and service level that you require. The available product codes are:
* GMPP: Packet Priority (Priority Service)
* GPT: Packet Tracked (Priority Service)
1. Go to **Settings**, then select **Couriers**.
2. Open your Deutsche Post Settings.
3. Click on **Add New Product Code**.
4. Enter the code and name.
5. Click **Add**.
6. Repeat steps 4-5 for each product code.
Once you have added products, you can set which product is to be used as the default for this carrier.
:::note
Deutsche Post doesn't pass rates into Starshipit, so they are not displayed in the New Order page. You can set up table rates for Deutsche Post though, where you record the rates that the courier charges you, and these are then available via the Starshipit API.
:::
### 3. Adjust your Air Waybill settings
Deutsche Post International operates by having individually labelled parcels grouped together into a bulk shipment sent from the originating (sender) EU country to Germany (or possibly Austria). This bulk shipment has an Air Waybill (AWB) attached. Once the bulk shipment has reached there, it is broken up into shipments to the final destinations.
Depending upon how Deutsche Post are handling your shipments, you can receive different types of AWB - these are output at manifesting time.
In the Advanced tab of the Deutsche Post settings, adjust your AWB cropping option, as appropriate.
Initially, it's best to leave the cropping option as **None**, and then when you've seen the type of AWBs produced, just change the setting to crop the AWB, or if you are happy with the AWB coming out as A4, you can just leave it with the cropping set to None.
---
### Other relevant information for you
* To read more about Deutsche Post API and AirWayBill (AWB), [click here](https://developer.dhl.com/api-reference/deutsche-post-international-post-parcel-germany#get-started-section/overview)
## Configure Deutsche Post settings
Use the **Settings** and **Advanced** tabs to control how Deutsche Post requests and labels are created:
| Setting | What it controls |
| --- | --- |
| **Enable Deutsche Post** | Enables the courier. |
| **Account Number (EKP)** | Identifies your Deutsche Post account. |
| **Default Export Type** | Sets the customs export type used when one is not selected on an order. |
| **Use Staging URL** | Uses the test endpoint. Leave this off for live shipments. |
| **AWB Label Cropping** | Crops the Air Waybill to the format supplied by Deutsche Post. Start with **None** until you have checked a generated AWB. |
| **AWB Label Count** | Sets how many AWB labels are required for pallets or mail sacks. |
| **Label Format** | Sets the paper size and layout Starshipit uses when it creates Deutsche Post labels. Choose the option that matches your printer. |
Add the product codes enabled on your Deutsche Post account before creating shipments.
---
# Set up DHL Express Global Mail
URL: https://support.starshipit.com/articles/8585800855695-set-up-dhl-express-global-mail
Canonical: https://support.starshipit.com/articles/8585800855695-set-up-dhl-express-global-mail
Markdown: https://support.starshipit.com/articles/8585800855695-set-up-dhl-express-global-mail.md
Updated: 2026-05-06
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Step-by-step guide to setting up DHL Express global mail.
* DHL Express Global Mail’s integration with Starshipit allows you to use Starshipit's features including generation of packing slips and shipping labels, auto-correction of addresses, branded tracking and notifications and many more.
* The DHL Express Global Mail integration can be used when you are wanting DHL Express to invoice you for your Deutsche Post shipments.
## Before you begin
You will need your:
* DHL Express Account Number
Deutsche Post needs to provide additional permissions for your account to be able to be used on Starshipit, so please ask us to contact them about this, passing us your account number.
Otherwise, you can contact Deutsche Post yourself, quoting your account number and asking them to add the permissions for Starshipit use with it.
## Setting up DHL Express Global Mail in Starshipit
### 1. Enter your account details in Starshipit
1. Navigate to **Settings** > **Couriers** > **Add Courier** > **DHL Express Global Mail**.
2. Check the **Enable DHL** **Express Globalmail** checkbox.
3. Enter your DHL Express account details.
4. Set your default export type.
### 2. Set up your product codes
Add your product codes to complete the integration. The selected option determines both the product code and service level that you require. The available product codes are:
* GMR - Plus (documents)
* GMM - Priority (documents)
* GMP - Priority (goods)
* GPT - Tracked
1. Navigate to **Settings** > **Couriers** > **DHL Express Global Mail**.
2. Click on **Add an existing product code**.
3. Select the product code.
4. Click **Add**.
5. Repeat steps 4-5 for each product code.
Once you have added products, you can set which product is to be used as the default for this carrier.
:::note
DHL Express Global Mail doesn't pass rates into Starshipit, so they are not displayed in the New Order page. You can set up table rates for DHL Express Global Mail, where you record the rates that the courier charges you, and these are then available via the Starshipit API.
:::
### 3. Adjust your Air Waybill settings
DHL Express Global Mail operates by having individually labelled parcels grouped together into a bulk shipment sent from the originating (sender) EU country to Germany (or possibly Austria). This bulk shipment has an Air Waybill (AWB) attached. Once the bulk shipment has reached there, it is broken up into shipments to the final destinations.
Depending upon how DHL Express Global Mail handles your shipments, you can receive different types of AWB - these are output at manifesting time.
In the Advanced tab of the DHL Express Global Mail settings, adjust your AWB cropping option, as appropriate.
Initially, it's best to leave the cropping option as **None**, and then when you've seen the type of AWBs produced, just change the setting to crop the AWB, or if you are happy with the AWB coming out as A4, you can just leave it with the cropping set to None.
### Global Mail Process
1. Generate Deutsche Post labels for each individual shipment.
2. Before you manifest your shipments at the end of the day, navigate to **Settings > Couriers > DHL Express Global Mail > Advanced** and set the number of AWB labels you need (this relates to the number of sacks you are sending).
3. Manifesting will generate the master DHL GMB Airwaybill/s.
4. Pack all of the parcels into a sack and attach the GMB Airwaybill/s.
## Configure DHL Express Globalmail settings
The **Settings** and **Advanced** tabs include:
| Setting | What it controls |
| --- | --- |
| **Use Sandbox Endpoints** | Uses DHL's test endpoints. Leave this off for live shipments. |
| **AWB Label Cropping** | Crops the master Air Waybill label. |
| **AWB Label Count** | Number of AWB labels required for the sacks or pallets being manifested. |
| **Label Format** | Sets the paper size and layout Starshipit uses when it creates DHL Express Global Mail labels. Choose the option that matches your printer. |
Add the product codes available on your DHL Express Globalmail account in **Product codes**.
---
# Enable DHL Express Paperless Trade
URL: https://support.starshipit.com/articles/214680543-enable-dhl-express-paperless-trade
Canonical: https://support.starshipit.com/articles/214680543-enable-dhl-express-paperless-trade
Markdown: https://support.starshipit.com/articles/214680543-enable-dhl-express-paperless-trade.md
Updated: 2026-05-06
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Enable DHL Express Paperless Trade for international shipments in Starshipit.
* Starshipit offer paperless trade for customers shipping internationally. This means you no longer have to include the commercial invoice on the package; you will only be required to attach the courier label. All of the customs documentation will be stored electronically and when it is scanned at customs the information will be displayed to customs.
## Set up
If you would like paperless trade, this first needs to be enabled by DHL Express and you will need to be paperless trade approved by DHL. Please talk to either your DHL sales manager or our [support team](https://help.starshipit.com).
To enable paperless trade within Starshipit, navigate to:
* **Settings** > **Couriers** > **DHL Express** > **Advanced** tab > Enable **Paperless Trade**.
---
# Set up DHL Express
URL: https://support.starshipit.com/articles/203806429-set-up-dhl-express
Canonical: https://support.starshipit.com/articles/203806429-set-up-dhl-express
Markdown: https://support.starshipit.com/articles/203806429-set-up-dhl-express.md
Updated: 2026-05-06
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Step-by-step guide to setting up DHL Express.
Set up [DHL Express](https://www.starshipit.com/partner/dhl-express) in Starshipit to ship domestically and internationally from any country, with live rates, commercial invoices, and Paperless Trade support. DHL Express integrates with all [Starshipit features](https://www.starshipit.com/features) including label generation, address correction, branded tracking, and notifications.
## Before you begin
You will need the following:
* DHL Account Number
* MyDHL API username (this is different to your MyDHL username)
* MyDHL API password (this is different to your MyDHL password)
If you don't have these credentials, please follow the below instructions as outlined by DHL Express:
1. Go to the [MyDHL API Portal.](https://developer.dhl.com/express)
2. Click **Get Access.**
3. Click on sign up or if you have already registered, please sign in with your login username & password.
4. You will receive similar registration email as below with your username & password.
5. Login to to complete & submit the onboarding request form. This will be sent to DHL for approval.
6. Fill out the following fields:
| | |
| --- | --- |
| **Name** | **Value** |
| How would you like to use the API? | I require credentials to DHL Express – MyDHL API for an existing plugin/ecommerce platform/third-party solution |
| Requestor Platform Name | Starshipit |
****
7. Once you complete the above onboarding request form, DHL will receive your credential request. They will then approve it and provide the credentials to you directly.
8. After receiving your MyDHL API credentials, you need to request production access. Click the red button located next to the API keys for this request. Please note that processing this request might take up to a day.
9. After requesting production access, you can proceed to set up DHL Express in Starshipit by following the steps below.
## Set up DHL Express in Starshipit
1. Go to **Settings** > **Couriers** > **Add Courier** > **DHL Express**.
2. Check the **Enable DHL** checkbox.
3. Select **MyDHL API.**
4. Fill in your account number, MyDHL API username, and MyDHL API password.
5. Click **Save**.
6. Set up your product codes.
Add your product codes to complete the integration.
1. Click **Add new product codes**.
2. Fill in details as required.
3. Click **Add**.
:::note
The most common product code for DHL Express is WPX for international and DOM for domestic.
:::
## Order DHL labels
To order DHL labels (100*200), you can request a supply from DHL [here](http://www.dhl.com.au/en/express/shipping/order_supplies.html).
## Commercial Invoices & Archive Waybills
International shipments sent via DHL Express require a Commercial Invoice and an Archive Waybill (label) to be supplied with the shipment. The Commercial Invoice should be attached to package and the Archive Waybill is to be given to the DHL driver.
In most cases DHL will approve your account to be setup with a service called [Paperless Trade.](https://www.dhl.com/discover/en-sg/ship-with-dhl/start-shipping/paperless-trade)
Paperless Trade allows the Commercial Invoice and Archive Waybill to be uploaded electronically to DHL instead of being printed.
If you are setup with Paperless Trade in Starshipit, then you will only receive a single DHL label. This is all that is required for international shipments.
Some countries do not support Paperless Trade. When you create a shipment to a country which does not support Paperless Trade, Starshipit will automatically supply you with a Commercial Invoice and Archive Waybill.
### How to enable Paperless Trade
1. In your Starshipit account, go to **Settings**, then select **Couriers**.
2. Select **Settings,**next to **DHL Express**.
3. Under the **Advanced** tab, tick the option **Paperless Trade**.
4. Scroll to the very bottom of the page, and click **Save**.
#### Optional: Adding custom information to the commercial invoice
If you have information you would like to include on the commercial invoice which only applies in certain scenarios, you can use the rules engine.
1. Go to **Settings** > **Rules** > **Create a new Rule.**
2. For the condition, select when you would like it to apply (For example Destination Country contains US).
3. For the action, select **Set Invoice Declaration Text** and then enter what you would like to include.
4. Click **Save.**
The commercial invoice will now include this on the invoice like so:
## Alternative account for duties and taxes
To set up your duties and taxes account number, follow the below steps:
1. Go to **Settings** > **Couriers** > **DHL Express** > **Advanced.**
2. Scroll down to the **Customs Invoice** section.
3. Enter the DHL Express account number that you would like to charge duties and taxes to for your DHL Express shipments. This can be a third party DHL Express account.
You can also set this up on a per order basis.
1. In Starshipit, open the order.
2. Scroll down and open the **Custom Details** section.
3. Edit the **Duty account #** field.
4. Click **Save**.
## Send duties and taxes to DHL
If you use Starshipit to record duties and taxes on DHL Express orders, you can choose whether those values are sent to DHL when the label is created.
Enable this when DHL should receive the indicative duties and taxes from Starshipit as part of the shipment request. This is useful for DDP workflows where duties and taxes have already been calculated or collected before dispatch.
To enable duties and taxes in the DHL request:
1. Go to **Settings > Couriers > DHL Express > Advanced**.
2. Open the **Customs Invoice** section.
3. Enable the setting to include indicative duties and taxes.
4. Click **Save**.
Before printing live shipments, test one international order and check that the duties and taxes shown in Starshipit are correct.
## Proforma invoices
A Proforma invoice is a customs document used when no commercial sale has taken place — for example, samples, gifts, or warranty replacements. Unlike a Commercial Invoice, it declares the goods and their value without implying a transaction. This helps ensure customs authorities don't apply duties based on a sale that didn't occur.
By default, DHL Express uses a Commercial Invoice for international shipments. To use a Proforma invoice instead:
1. Go to **Settings** > **Couriers** > **DHL Express** > **Advanced**.
2. Scroll down to the **Customs Invoice** section.
3. Under **Invoice Type**, select **Proforma**.
4. Click **Save**.
## GoGreen Plus
Reduce your carbon emissions with the DHL Express GoGreen Plus service. If you select the GoGreen Plus service you will incur and additional charge from DHL Express. This cost is visible in the Shipping Breakdown in UI2.0 or by hovering over the estimated rate in the classic UI.
To default the GoGreen Plus service on all eligible DHL Express shipments follow the below steps:
1. Go to **Settings > Couriers > DHL Express > Advanced.**
2. Navigate to the **Delivery Options**section.
3. Select the option **GoGreen Plus**. This will default and automatically apply the GoGreen Plus service to all DHL Express shipments.
## Troubleshooting
1. Error: "Please provide a package description"
* In **Settings** > **Options** > **Package Description**, provide a general description of your products (e.g. Clothing, Cosmetic Product, Swimwear).
2. Error: "The system could not verify your shipping account number. Please correct this number and resubmit. For assistance call your DHL customer services representative."
* Contact your DHL account manager because there is an issue with your DHL account.
3. Error: "An error has occurred while uploading your file".
* If you see this error when you're attempting to upload a file for your signature/letterhead, please ensure that the "**Use staging URL**" checkbox is unticked in your settings.
## Configure DHL Express settings
DHL Express settings cover API access, label output, delivery defaults, customs, and returns. The available controls are:
| Area | Settings |
| --- | --- |
| **Page size** | Choose the paper size and layout for **Format for outbound labels** and **Format for return labels** so labels work with your printer. |
| **Delivery options** | **Display transit times** and **Delivery Service Description**, which controls the text shown at checkout. |
| **Default delivery services** | **Authority to leave**, **Duties & Taxes Paid**, **GoGreen Plus**, **Adult Signature**, **Incoterm**, **Service point mode**, and **Enable Cash On Delivery**. |
| **Archive and label branding** | **Generate Archive Label for International Shipments**, **Generate Archive Label for Domestic Shipments**, **Hide DHL logo on labels**, **Use line item descriptions on labels**, **Display SKUs on labels**, **Display custom logo on labels and invoices**, **Custom logo**, **Display custom logo on commercial invoices**, and **Commercial invoice logo**. |
| **Returns** | **Create a return label for all outgoing packages**, **Return DHL account number**, and **Resize return labels**. |
| **Paperless trade and invoices** | **Paperless Trade (PLT)**, **Include indicative Tax and Duty where available**, **Reason for Export (Outbound)**, **Reason for Export (Returns)**, **Commercial Invoice Remarks**, **Number of Invoices**, **Invoice Type**, **DHL Duty and Tax number**, **Let DHL generate the commercial invoice**, **Email Invoice & AWB**, and **Cost of Shipping on the Commercial Invoice**. |
| **Order and contact data** | **Use sender phone number if destination phone not present**, **Use sender email address if destination email address is not present**, **Use generic description for all items in data sent to DHL**, **Use generic descriptions on the Commercial Invoice for all items**, **Apply data staging to outbound shipments**, **Use THEIR REFS as Customer Reference**, **Payment Country/Region**, **Data Staging**, **Unknown Sender**, and **Use DHL API for available products**. |
| **Dangerous goods** | **Dangerous Goods**, **Dangerous Goods Product Name**, **Select dangerous goods type**, and **Custom Dangerous Goods Text**. Choose the warning that matches the goods and confirm the choice with DHL. |
| **International and regional tax** | **Select the default pricing strategy** for duties and taxes, **ARN/ABN Number**, **EORI Number**, and **NZ IRD Number**. |
| **Other label defaults** | **Resize 100x200 labels to 100x150**, **Signature Required**, **Use 2019 Signature Required**, **Use detailed item descriptions on the label**, **Authority To Leave (default option)**, **Duties & Taxes Paid (default option)**, and **Display SKUs on Labels**. |
| **Break Bulk Express (BBX/BBE)** | Configure the BBX switch, contact name, contact email, phone, company, building, street, locality, city, postcode, state, country, country code, FOC account number, countries to apply, and whether to use BBE. DHL must enable this service for your account. |
Settings shown depend on the selected API version and account permissions. Save after changing a setting, then create a test shipment to check the label, invoice, and delivery defaults.
## Other relevant information
* For more information on DHL Express WayBills, [click here.](https://www.dhl.com/discover/en-global/ship-with-dhl/documents-and-customs-advice/how-to-create-a-waybill)
* If you use BBX (Break Bulk Express), you'll need to request DHL to whitelist you for using XML-PI for it. See also [DHL Express Break Bulk Express (BBX) Setup](/articles/couriers/dhl/set-up-dhl-express-break-bulk-express-bbx-bbe-break-bulk-economy).
---
# Add a digital signature to DHL Express commercial invoices
URL: https://support.starshipit.com/articles/360000273875-add-a-digital-signature-to-dhl-express-commercial-invoices
Canonical: https://support.starshipit.com/articles/360000273875-add-a-digital-signature-to-dhl-express-commercial-invoices
Markdown: https://support.starshipit.com/articles/360000273875-add-a-digital-signature-to-dhl-express-commercial-invoices.md
Updated: 2026-05-06
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Some countries' customs departments require a signature on the DHL Express. commercial invoice. Follow the instructions below on how to add your signature in Starshipit.
* Some countries' customs departments require a signature on the DHL Express commercial invoice.
* Follow the instructions below on how to add your signature in Starshipit.
* The signature will be added to every invoice including the one submitted via Paper Less Trade (PLT)
## Setting up your digital signature
1. Make a signature on a piece of paper then take a photo of it or create a digital signature.
2. In Starshipit, go to **Settings** > **Digital signatures**.
3. Upload your signature image (Maximum: 1MB, Width 380px, Height 140px).
4. Click **Save**.
---
# Set up DHL eCommerce Asia Pacific
URL: https://support.starshipit.com/articles/204681005-set-up-dhl-ecommerce-asia-pacific
Canonical: https://support.starshipit.com/articles/204681005-set-up-dhl-ecommerce-asia-pacific
Markdown: https://support.starshipit.com/articles/204681005-set-up-dhl-ecommerce-asia-pacific.md
Updated: 2026-05-06
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Step-by-step guide to setting up DHL eCommerce asia pacific.
* DHL eCommerce Asia Pacific's integration with Starshipit allows you to generate packing slips and shipping labels, send branded tracking notifications, generate live rates at checkout and writeback tracking to your chosen platform.
* This article outlines how to set up [DHL eCommerce Asia Pacific](https://www.dhl.com/global-en/microsites/ec/ecommerce-insights/about-dhl-ecommerce.html) as a courier service in Starshipit.
## Before you begin
You'll need the following:
* DHL eCommerce Asia Pacific account numbers (Pick Up and Sold To)
* DHL eCommerce Asia Pacific Dispatch ID
* Product codes
If you don't have these credentials, please contact your DHL account manager to request this. Alternatively, you can contact our support team [here](https://help.starshipit.com) with your DHL eCommerce Asia Pacific account number and we can request credentials on your behalf.
## 1. Add your DHL eCommerce Asia Pacific details in Starshipit
1. In Starshipit, navigate to **Settings** > **Couriers** > **Add a new courier**.
2. Select that country you are shipping from in the drop-down.
3. Select **DHL eCommerce Asia Pacific**.
4. Tick **Enable DHL eCommerce Asia Pacific**.
5. Complete the fields **Pick Up No**, **Sold To No** and **Prefix Code** with your details.
6. Select **Use the API to generate labels and manifests**.
7. Enter your **Pick up** and **Sold To** numbers.
8. Click **Save**.
## 2. Set up your product codes
Add your product codes to complete the integration.
1. Click **Add a new product code**.
2. Fill in details as required.
3. Click **Add**.
## Live quotes for shipments
Starshipit supports displaying live quotes for your DHL eCommerce shipments using DHL eCommerce's technology "Gemini". These quotes will be based on your rate card with DHL eCommerce. This is enabled on all DHL eCommerce shipments automatically.
## Advanced settings
#### Generate Customs Invoice
You can generate a commercial invoice for your DHL eCommerce Asia Pacific international shipments. To enable this feature:
1. Navigate to **Settings** > **Couriers** > **DHL eCommerce Asia Pacific** > **Advanced**.
2. Tick **Generate Customs Invoice for International Orders**.
3. Click **Save**.
#### Default Handover Methods
You can set the default handover method when you manifest orders for DHL eCommerce.
If you see an error message "Shipment(s) not allowed for handoverMethod - 2", under the dropdown options, select the **Drop-Off** option then click **Save**.
####
#### Ensure the order number is incorporated into the tracking number
DHL eCommerce can adjust the tracking number/shipmentID used, which is useful for matching shipments sent with DHL eCommerce to the original order number. The format for this adjustment will be:
```
+ ordernumber + 00 (padded to 9 characters)
```
To activate this feature on your account:
1. Go to **Settings** > **Couriers** > **DHL eCommerce Asia Pacific**.
2. Check the box for **Use OurRef for the ShipmentID**.
3. Press **Save**.
## Configure DHL eCommerce Asia Pacific settings
The settings are divided into **Settings**, **FTP**, **Testing**, and **Advanced**:
| Setting | What it controls |
| --- | --- |
| **Enable DHL eCommerce Asia Pacific** | Enables the courier. |
| **Use the API to generate labels and manifests** | Uses the API workflow instead of the FTP workflow. |
| **Use Staging URL** | Uses the test endpoint. Leave it off for live shipments. |
| **Use OurRef for the ShipmentID** | Includes your order reference in the shipment ID. |
| **Prefix Code** | The DHL prefix used for shipment IDs. |
| **Pick Up No** and **Sold To No** | DHL account numbers used for pickup and billing. |
| **FTP Account No** | The account used when the FTP workflow is selected. |
| **Use sender phone/email if destination is blank** | Provides sender contact details as a fallback. |
| **Use Default Item Description for Items** | Uses the default item description from **Settings > Options**. |
| **Display SKUs in label** | Prints item SKUs on labels. |
| **Automatically manifest** | Manifests orders automatically at the end of the day. |
| **Generate Customs Invoice for International Orders** | Creates a customs invoice for international shipments. |
| **Set DTP for all services** | Applies the selected duty-and-tax-paid value to services. |
| **Default Handover Methods** and **Default Return Methods** | Sets the handover and return methods sent to DHL. |
| **Content Export Description** | The description used for international content exports. |
The **Testing** tab contains manifest test actions such as manifesting outstanding orders, forcing all orders, and re-manifesting tracking numbers or a manifest. Use these actions only when testing or recovering a manifest.
---
# Set up DHL eCommerce Americas
URL: https://support.starshipit.com/articles/13547212368143-set-up-dhl-ecommerce-americas
Canonical: https://support.starshipit.com/articles/13547212368143-set-up-dhl-ecommerce-americas
Markdown: https://support.starshipit.com/articles/13547212368143-set-up-dhl-ecommerce-americas.md
Updated: 2026-05-06
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Step-by-step guide to setting up DHL eCommerce Americas.
* DHL eCommerce America’s integration with Starshipit allows you to generate packing slips and shipping labels, send branded tracking notifications, generate live rates at checkout and writeback tracking to your chosen platform.
* This integration allows you to connect your DHL eCommerce Americas account and streamline domestic parcel delivery across the United States
* This article outlines how to set up DHL eCommerce Americas as a courier service in Starshipit.
## Before you begin
To connect your DHL eCommerce Americas account in Starshipit, you’ll need the following credentials:
* **API Client ID**
* **API Client Secret**
* **Pickup Account Number** – Provided during onboarding by the DHL implementation team (not the same as your Sold To account).
* **Distribution Center Code** – The US-based DHL distribution center where your parcels will be lodged post-pickup.
:::note
If you don’t have these credentials, contact your DHL eCommerce Americas onboarding manager or reach out to our support team for assistance.
:::
## Add your DHL eCommerce Americas details
1. In Starshipit, navigate to **Settings > Couriers > Add a new courier.**
2. Select **United States** from the *Shipping From* dropdown.
3. Choose **DHL eCommerce Americas.**
4. Tick **Enable DHL eCommerce Americas.**
5. Enter the following:
* **API Client ID**
* **API Client Secret**
* **Pickup Account Number**
* **Distribution Center Code**
6. Click **Save** to confirm your integration settings.
## Add your product codes
DHL eCommerce Americas supports a range of product types for domestic delivery. To set up the services you want to use:
1. Navigate to the **Product Codes** section in the DHL eCommerce Americas settings.
2. Click **Add an existing Product Code**.
3. Select one of the available DHL codes:
* **EXP** – DHL SmartMail Parcel / Parcel Plus Expedited
* **GND** – DHL SmartMail Parcel / Parcel Plus Ground
* **MAX** – DHL SmartMail Parcel Expedited Max
* **PLT** - DHL Parcel International Direct (International)
4. Click **Add** to save the product code.
:::note
You can add multiple product codes and set one as the default service if preferred.
:::
## Shipping internationally
You can ship internationally from **Canada** or the **United Kingdom** using **DHL eCommerce Americas International**.
Select the product code **PLT** International when creating your shipment.
When printing a label, ensure you include at least one **customs detail**, such as an HS code, item value, or country of origin.
:::note
Rates are not available for international shipments, but labels will generate successfully when valid customs details are provided.
:::
## Configure DHL eCommerce Americas settings
The **Settings** tab contains:
| Setting | What to enter or choose |
| --- | --- |
| **Use Sandbox** | Uses DHL's test environment. Leave this off for live shipments. |
Add the enabled DHL product codes and mark one as the default service if required.
---
# Set up DHL Express Break Bulk services
URL: https://support.starshipit.com/articles/7342771342479-set-up-dhl-express-break-bulk-services
Canonical: https://support.starshipit.com/articles/7342771342479-set-up-dhl-express-break-bulk-services
Markdown: https://support.starshipit.com/articles/7342771342479-set-up-dhl-express-break-bulk-services.md
Updated: 2026-05-06
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Step-by-step guide to setting up DHL Express break bulk express (bbx) & bbe (break bulk economy).
* Configure the DHL Express BBX (BREAK BULK EXPRESS) & BBE (Break Bulk Economy) service for generating shipping labels within Starshipit.
* DHL Express BBX & BBE service is available on the MyDHL API in UI 2.0.
## About DHL Express BBX
BBX offers a door-to-door shipping solution that centers around consolidating shipments at their starting point, bundling them into a singular substantial shipment. These aggregated shipments are then dispatched from one customs zone to another, allowing for the streamlined clearance of the consolidated package as a solitary entry upon arrival at the destination customs zone facility.
Once the shipment successfully navigates through customs procedures, DHL undertakes the task of deconstructing the consolidated shipment into its individual orders (referred to as the baby shipments), thereby facilitating the final leg of the delivery journey.
To facilitate this consolidation process, Starshipit offers support in generating a DHL parent air waybill (AWB) for the consolidated package, as well as child AWBs (also referred to as baby shipments) for the separate individual packages.
## What you need to get started
Before getting started with BBX you will need:
* Agreed contract with DHL Express to use BBX service. If you are not set up to use BBX please reach out to your DHL Express account manager.
* DHL Express Account number
* MyDHL API Key
* MyDHL API Secret
Reach out to your DHL Express account manager or refer to our [DHL Express setup article.](/articles/couriers/dhl/how-to-set-up-dhl-express)
## 1. Set up DHL Express BBX
Before you begin, you'll need to set up [DHL Express.](/articles/couriers/dhl/how-to-set-up-dhl-express) Once configured, you need to add the BBX product code to your account. The product code will only be available if DHL has set this up on your account from their side.
1. In Starshipit, navigate to **Settings** > **Couriers** > **DHL Express Settings**.
2. Add new product codes.
3. Add the product code **BBX** (Breakbulk Express) and the product code **BBE** (Break Bulk Economy).
4. Click **Save**.
## 2. Set up your BBX Address and FOC account number
DHL Express will provide you with your BBX/BBE address and FOC (Free of charge) account number. The BBX/BBE Address is a DHL Warehouse and will be the receiver on your parent label.
To set up your BBX/BBE Address and FOC account number follow the below steps:
1. In Starshipit, navigate to **Settings > Couriers > DHL Express Settings**.
2. Scroll down to **BBX/BBE Parent shipping locations** and select **Add new.
3. Add the **address and FOC account number provided by DHL.**
4. Select the countries this address should apply to **(the countries of your baby shipment's final destination).**
5. **If the address is associated with BBE, select DHL Economy Breakbulk.**
6. Click **Save**.
## Processing a BBX shipment
## 1. Generate the Parent ID and Pallet ID
The parent ID pertains to the entire shipment, while the Pallet ID corresponds to the identification of each individual pallet within the shipment. A single shipment can encompass multiple pallets.
1. In the **New** orders tab select the orders you wish to assign the same Parent ID and Pallet ID. The destination country for these orders will need to match your BBX location set up in the DHL Express settings.
2. Select **'BBX/BBE'** from the bulk action.
3. Select **'Generate Parent ID**'.
4. Select **'Generate Pallet ID**'.
5. Click **Save**.
6. Your shipments will now be assigned a Parent ID and Pallet ID. You can view the Parent ID and Pallet ID within an order.
7. You can only generate **1 Parent ID** at a time. You will need to **complete Steps 1 - 4** before you are able to generate another Parent ID.
## 2. Print child shipment labels
Once you have assigned your Parent ID and Pallet ID number you can start processing your child AWBs. **Before printing your child shipments please ensure you have item descriptions, weights, and values as these are mandatory - you will not be able to generate a parent label if your child shipments do not contain item details.**
1. Select your orders with **BBX product code** (similarly for **BBE**).*Quick tip! You can create a saved view or filter your orders in the search bar by entering BBX.*
2. Select **'Print shipping labels'**
3. Your orders will move to the printed tab.
## 3. Create Parent label
When you have printed your child shipment labels, the next step is to create your parent label. **Before creating your parent label please ensure you have printed all relevant child shipments - there is no option to redo this step and add additional child shipments.** This is the label that will go on the outside of the pallet. To create your parent label follow the below steps:
1. Navigate to the **printed tab**
2. Select your **BBX orders**
3. In the bulk action select '**BBX'**
4. Select '**Confirm'** in the pop up
5. Your parent label will download or print to your dedicated printer
6. Your **child shipments** will move to the **shipped tab.** An order will be created in the **printed tab with the parent label details**. Within this order you can **reprint your parent label or view the parent label tracking details**.
---
# Enable Landed Cost Estimator for DHL Express
URL: https://support.starshipit.com/articles/9181479000335-enable-landed-cost-estimator-for-dhl-express
Canonical: https://support.starshipit.com/articles/9181479000335-enable-landed-cost-estimator-for-dhl-express
Markdown: https://support.starshipit.com/articles/9181479000335-enable-landed-cost-estimator-for-dhl-express.md
Updated: 2026-05-06
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Learn how to enable the Landed Cost Estimator for DHL Express in Starshipit.
* [Overview](/articles/couriers/dhl/enable-landed-cost-estimator-for-dhl-express#h_01HRB4TC6N26BVWR7NAHXGGCZE)
* [How it works](/articles/couriers/dhl/enable-landed-cost-estimator-for-dhl-express#h_01HRB4V5JT6K4T6Z1QAYGFY9SW)
* [Pricing strategy](/articles/couriers/dhl/enable-landed-cost-estimator-for-dhl-express#h_01HRB4S9P204CA3PWVAHE50K23)
* [Disclaimer](/articles/couriers/dhl/enable-landed-cost-estimator-for-dhl-express#h_01HRB4Y5YJ99J2GCJANPT01QDE)
* Starshipit now supports the Landed Cost* (Duties, Taxes, and Other Regulatory Fees - Importing) estimator for DHL Express
## How it works
The Landed Cost Estimator takes into account product details in the shipment to enhance your ability to estimate and manage the total cost of your shipments, ensuring a transparent and hassle-free experience. You can enable this in your Starshipit account.
1. Sign in to your [Starshipit](https://app2.starshipit.com/) account.
2. Navigate to **Settings** > **Courier**.
3. Go to DHL Express **Settings** > **Advanced** tab.
4. Scroll down to **Estimated Tariff Rate Type**.
5. From the drop-down menu, select your default pricing strategy for calculating duties and taxes.
6. Click **Save**.
Once the pricing strategy is selected, the **Estimated Duties, Taxes, and Other Regulatory Fees (Importing)** for supported countries will be displayed in the order details under the shipping breakdown.
## Pricing strategy
#### Actual Rate
The actual rate will only be returned if the full import Harmonized System Code (HS Code) is provided. If the full HS Code is not provided, an error will be returned.
#### Highest Rate
If the full import Harmonized System code (HS Code) is provided, the actual rate will be returned. However, if the HS Code is not provided, the highest derived rate will be returned.
#### Center Rate
If the full import Harmonized System code (HS Code) is provided, the actual rate will be returned. However, if the HS Code is not provided, the measure of the centre (mode/average) derived rate will be returned.
#### Lowest Rate
If the full import Harmonized System code (HS Code) is provided, the actual rate will be returned. However, if the HS Code is not provided, the lowest derived rate will be returned.
## *Disclaimer
* Duties and tax estimates are based on the details you have provided.
* Actuals upon shipping may vary and are subject to authorities.
* DHL has no liability or responsibility for differences between this indicative breakdown and the actual costs.
* Your final landed cost may differ based on the characteristics of the shipment, services requested and the packages actually tendered to DHL.
* While we have made every attempt to ensure that the information contained herein has been obtained, produced and processed from sources believed to be reliable, no warranty, express or implied, is made regarding the accuracy, adequacy, completeness, legality, reliability or usefulness of such information.
* All information contained herein is provided on an “as is” basis. In no event will DHL Express, its related partnerships or corporations under the DHL Group, or the partners, agents or employees thereof be liable to you or anyone else for any decision made or action taken in reliance on the information contained herein or for any consequential, special or similar damages, even if advised of the possibility of such damages.
---
# Set up DHL Parcel UK
URL: https://support.starshipit.com/articles/360001121516-set-up-dhl-parcel-uk
Canonical: https://support.starshipit.com/articles/360001121516-set-up-dhl-parcel-uk
Markdown: https://support.starshipit.com/articles/360001121516-set-up-dhl-parcel-uk.md
Updated: 2026-02-11
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Step-by-step guide to setting up DHL Parcel UK.
* DHL Parcel UK's [integration with Starshipit](https://starshipit.com/partner/ups-shipping-software) allows you to use all of [Starshipit's features](https://www.starshipit.com/features) including generation of packing slips and shipping labels, auto-correction of addresses, branded tracking and notifications and many more.
* This article outlines how to set up DHL Parcel UK as a courier service in Starshipit.
## Before you begin
* Create a DHL Parcel UK account [here](https://send.dhlparcel.co.uk/auth/register) (if you don't already have one).
DHL Parcel UK will provide you an Account Number, a Username and a Password.
## 1. Enter your account details in Starshipit
1. In [Starshipit](https://app2.starshipit.com/), navigate to **Settings** > **Couriers** > **Add a new courier**
2. Select the country you're shipping from and select **DHL Parcel UK**.
3. Tick **Enable DHL Parcel UK**.
4. Enter your Account Number, Username and Password.
5. Click **Save**.
6. Click **Test to ensure it works** to validate that your credentials are correct.
## 2. Set up parcel collection date/time
You can set up collection of packages to be at a certain number of minutes after the time of printing of an order's label.
Or, you can set it to a regular daily time that you have booked with DHL Parcel UK. If you do this, the date can be set in the future for the next date to be used, or if it is today or was previously set and that date is now in the past, then today's date will always be used.
You can also override this setting on any individual order and the new value will be saved as the new overall setting.
:::note
You cannot set the collection date to be in the past when modifying, and collections are only available Monday to Friday. If it has been agreed with DHL Parcel UK and you intend to dispatch consignments over a weekend or a Bank Holiday, please make your DHL Parcel UK contact aware before proceeding.
:::
## 3. Set up your product codes
Add your product codes to complete the integration. The most common product codes are as follows:
### Parcels
Signature Service to the specified address and neighbour:
| Product Code | Product Description |
| --- | --- |
| 1 | Next Day |
| 4 | Saturday |
| 48 | 48 Hour |
Signature Service to the specified address only:
| Product Code | Product Description |
| --- | --- |
| 220 | Next Day |
| 225 | Saturday |
Leave Safe at specified address or signature service to neighbour:
| Product Code | Product Description |
| --- | --- |
| 210 | Next Day |
| 215 | Saturday |
| 72 | 48 Hour |
### Bagit Small (and Express)
Signature Service to the specified address and neighbour:
| Product Code | Product Description |
| --- | --- |
| 40 | Next Day |
| 43 | Saturday |
Signature Service to the specified address only:
| Product Code | Product Description |
| --- | --- |
| 240 | Next Day |
| 245 | Saturday |
:::note
DHL Parcel UK doesn't pass rates into Starshipit, so these will not be displayed on the New Order page. You can, however, set up table rates for DHL Parcel UK within Starshipit, where you would record the rates that the courier charges you and retrieve these via our own API.Parcel tracking is not currently supported at this time.DHL Parcel UK only accept integrals for the package weight. So we will always round the weight up when printing.
:::
## Configure DHL Parcel UK settings
The **Settings**, **Collection**, and **Advanced** tabs include:
| Setting | What it controls |
| --- | --- |
| **Use Staging URL** | Uses the test endpoint. Leave this off for live shipments. |
| **Set pickup for an offset from now** | Schedules collection a number of minutes after printing. |
| **Set pickup for a specific date and time** | Schedules collection for the selected date and time. The date must not be in the past or more than seven days ahead. |
| **Closed for lunch** and **Latest time** | Describes the collection window used by the courier. |
| **Use sender phone number if destination phone not present** | Uses the sender phone as a fallback. |
| **Signature Required (default option)** | Applies signature required by default. |
Use the **Tools** tab to enter a destination and parcel dimensions, then look up available products and prices. Add the returned product codes in the product-code table.
---
# Configure DHL Express dangerous goods
URL: https://support.starshipit.com/articles/6436411966735-configure-dhl-express-dangerous-goods
Canonical: https://support.starshipit.com/articles/6436411966735-configure-dhl-express-dangerous-goods
Markdown: https://support.starshipit.com/articles/6436411966735-configure-dhl-express-dangerous-goods.md
Updated: 2026-05-06
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Starshipit supports sending DHL Express dangerous goods types from one. Starshipit account. Account approval with DHL Express is required before shipping Dangerous Goods.
* Starshipit supports sending DHL Express dangerous goods types from one Starshipit account.
* Account approval with DHL Express is required before shipping Dangerous Goods. Contact your DHL Express account manager for approval.
* Setting an order to contain Dangerous Goods can be set via Rules or via API to contain a contentID which specifies the type of dangerous goods.
### Table of Dangerous Goods Types
The dangerous goods types and their respective contentIDs are listed in the table below:
| # | Dangerous Goods Description | contentID | Service Code (DHL) | Product Codes |
| --- | --- | --- | --- | --- |
| 1 | Lithium ion batteries in compliance with Section II of PI965 | **965** | HB | WPX, ECX, TDT, TDY, TDM, TDE, TDK, BBX, CMX, WMX, DOM |
| 2 | Lithium ion batteries in compliance with Section II of PI966 | **966** | HD | WPX, ECX, TDT, TDY, TDM, TDE, TDK, BBX, CMX, WMX, DOM |
| 3 | Lithium ion batteries in compliance with Section II of PI967 | **967** | HV | WPX, ECX, TDT, TDY, TDM, TDE, TDK, BBX, CMX, WMX, DOM |
| 4 | Lithium ion batteries in compliance with Section II of PI969 | **969** | HM | WPX, ECX, TDT, TDY, TDM, TDE, TDK, BBX, CMX, WMX, DOM |
| 5 | Lithium ion batteries in compliance with Section II of PI970 | **970** | HW | WPX, ECX, TDT, TDY, TDM, TDE, TDK, BBX, CMX, WMX, DOM |
| 6 | Consumer Goods ID8000 | **700** | HK | WPX, ECX, DOM |
| 7 | Metal PI968 Section IA (LiBa) | **911** | HE | WPX, ECX, CMX, WMX, NFO, FRT |
| 8 | Metal PI968 Section IB (LiBa) | **911** | HE | WPX, ECX, CMX, WMX, NFO, FRT |
| 9 | Metal PI970 Section I (LiBa in equipment) | **910** | HE | WPX, ECX, CMX, WMX, NFO, FRT |
| 10 | Biological substances UN3373 | **650** | HY | CMX, WMX |
| 11 | Limited quantities to the limits of ADR | **A01** | HL | DOM, DOT, DOL, DOK, ESI, ESU, SPL |
| 12 | UN2807 Magnetized Material | **HT1** | HX | |
| 13 | UN3164 PI208a Articles Pressurized Hydraulic | **HU1** | HU | |
| 14 | UN3164 PI208a Articles Pressurize Pneumatic | **HU2** | HU | |
| 15 | Exempt Human Specimen | **HU3** | HU | |
| 16 | Exempt Animal Specimen | **HU4** | HU | |
| 17 | Genetically modified organisms/microorganisms | **651** | HY | CMX, WMX |
| 18 | ADR Load Exemptions | **A02** | HN | DOM, DOT, DOL, DOK, ESI, ESU, SPL |
| 19 | *Dry Ice UN1845* | *901* | *HC* | ***Not supported by SSI at this time* |
| 20 | *Excepted quantities in accordance with IATA* | ***E01*** | *HH* | ***Not supported by SSI at this time* |
### Assign DHL Express dangerous goods to an order via rules
To assign dangerous goods types via the rule follow the below steps:
1. In Starshipit, navigate to **Settings** > **Rules**.
2. Create a new rule with any condition e.g SKU equals 12345.
3. Select the action **Set Dangerous Goods Type**.
4. Enter the **contentId** of the Dangerous Goods type you are using (contentId can be found in the above table).
5. Click **Save**.
6. Repeat steps 1-5 for each dangerous goods type you would like to set.
On import, if the value added matches a contentID (from the table above), any order meeting the conditions of the rule will be set with the specified contentID and will see the Dangerous Goods option ticked in the UI and in the shipping breakdown within an order. If the value does not match any contentID, no changes will be made to orders meeting the conditions of the rule.
### Important
* Starshipit currently supports one dangerous goods type per order, if you are sending multiple dangerous goods in one shipment you will need to split the order.
* At this time, Starshipit does not support Dry Ice for dangerous goods type.
---
# Set up DHL Parcel Europe
URL: https://support.starshipit.com/articles/360000968975-set-up-dhl-parcel-europe
Canonical: https://support.starshipit.com/articles/360000968975-set-up-dhl-parcel-europe
Markdown: https://support.starshipit.com/articles/360000968975-set-up-dhl-parcel-europe.md
Updated: 2026-05-06
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Step-by-step guide to setting up DHL Parcel europe.
* Set up [DHL Parcel Europe](https://www.dhl.com/global-en/home.html) as a courier service in Starshipit.
* DHL Parcel Europe is also known as [DHL Paket](https://www.dhl.de/en/privatkunden/pakete-empfangen/verfolgen.html) [and previously Global Mail](https://www.dhl.de/en/privatkunden/pakete-empfangen/verfolgen.html)
## Before you begin
Before you set up DHL Parcel Europe, you'll need your:
* DHL Parcel Europe Account Number (10-digit account number)
* DHL Parcel Europe German Sender Code
(Optional - Allows packages to be sent using German product codes)
* DHL Parcel Europe Austrian Sender Code
(Optional - Allows packages to be sent using Austrian product codes)
* Default Export Type - for international shipments
If you are missing these credentials, please contact your DHL Parcel Europe account manager.
## 1. Enter your account details in Starshipit
1. In [Starshipit](https://app2.starshipit.com/), go to **Settings** > **Couriers** > **Add a new courier**.
2. Select the country you're shipping from in the dropdown.
3. Click **DHL Parcel Europe**.
4. Tick **Enable DHL Parcel Europe**.
5. Enter your DHL Account Number.
6. Enter your German/Austrian Sender Code if required.
7. Set a default customs export type.
8. Click **Save**.
9. Click **Test to ensure it works** to verify that your credentials are correct.
## 2. Set up your product codes
Add your product codes to complete the integration. The available product codes are:
**German Sender/German Destination**
* V01PAK: DHL Paket (Parcel)
* V06PAK: DHL Paket Taggleich (Parcel Same-Day)
* V06TG: DHL Kurier Taggleich (Courier Same-Day)
* V06WZ: DHL Kurier Wunschzeit (Courier Preferred-Time)
**German Sender/European Destination**
* V54EPAK: DHL Europaket (Europarcel)
* V55PAK: DHL Paket Connect (Parcel Connect)
**German Sender/International Destination**
* V53WPAK: DHL Paket International (Parcel International)
**Austrian Sender/Austrian Destination**
* V86PARCEL: DHL Paket Austria (Parcel Austria)
**Austrian Sender/European Destination**
* V87PARCEL: DHL Paket Connect (Parcel Connect)
**Austrian Sender/International Destination**
* V82PARCEL: DHL Paket International (Parcel International)
:::note
To send from a country other than Germany or Austria (e.g. the UK), you'll need a German or Austrian sender code. This is provided by DHL.DHL Parcel Europe doesn't pass rates into Starshipit, so they are not displayed in the New Order page. You can set up table rates for DHL Parcel Europe though, where you record the rates that the courier charges you, and these are then available via the Starshipit API.
:::
## Configure DHL Parcel Europe settings
The **Settings** and **Advanced** tabs include:
| Setting | What it controls |
| --- | --- |
| **API Version** | Selects the DHL API version configured for your account. |
| **Participation** | Selects the participation or account arrangement supplied by DHL. |
| **Use Staging URL** | Uses the test endpoint. Leave this off for live shipments. |
| **Default Export Type** | Sets the default customs export type. |
| **Duties & Taxes Paid** | Makes the sender responsible for duties and taxes by default. |
| **Generate return labels** | Generates return labels automatically. |
| **Use sender phone number** | Uses the sender phone when the destination phone is blank. |
| **Preferred delivery time** | Sets the preferred delivery time for supported products. |
| **Label format** | Sets the paper size and layout Starshipit uses when it creates DHL Parcel Europe labels. Choose the option that matches your printer. |
Add your product codes in the product-code table. The **Tools** tab can delete a shipment by tracking number.
---
# Reprint a DHL Express commercial invoice
URL: https://support.starshipit.com/articles/217239806-reprint-a-dhl-express-commercial-invoice
Canonical: https://support.starshipit.com/articles/217239806-reprint-a-dhl-express-commercial-invoice
Markdown: https://support.starshipit.com/articles/217239806-reprint-a-dhl-express-commercial-invoice.md
Updated: 2026-05-06
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> This article outlines how to reprint a DHL Express commercial invoice.
* This article outlines how to reprint a DHL Express commercial invoice.
:::note
These steps can only be carried out if the order has already been printed and is only available for DHL Express. Other couriers display invoices directly on their labels.
:::
## Reprint a DHL Express commercial invoice
DHL Express requires all international shipments to contain a commercial invoice. These can be sent electronically using paperless trade (PLT) however, where not supported you are required to attach a commercial invoice to your package.
1. In [Starshipit](https://help.starshipit.com), open the order using the Search function or from the Printed or Shipped sections.
2. Click **Actions on** the top right, then select **Download Commercial Invoice**.
3. The PDF of the invoice will be automatically downloaded onto your computer.
---
# Set up Direct Freight
URL: https://support.starshipit.com/articles/4858091402511-set-up-direct-freight
Canonical: https://support.starshipit.com/articles/4858091402511-set-up-direct-freight
Markdown: https://support.starshipit.com/articles/4858091402511-set-up-direct-freight.md
Updated: 2026-05-06
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Step-by-step guide to setting up Direct Freight.
Connect Direct Freight to Starshipit to create Australian domestic shipments. Direct Freight labels use the 100 × 200 mm format.
## Before you begin
Have these details from Direct Freight ready:
- Account number
- Site ID
- Consignment, pricing, and tracking API keys
If you're missing any of the above fields, see [our guide](/articles/couriers/direct-freight/direct-freight-api-access) on how to request this from Direct Freight.
## Set up Direct Freight
1. In Starshipit, navigate to **Settings** > **Couriers** > **Add a new Courier** > **Direct Freight**.
2. Tick **Enable Direct Freight**.
3. Enter your account number, site ID, and API keys. Direct Freight may provide the same key for consignment, pricing, and tracking.
4. Click **Save**.
5. Click **Test to ensure it works** to verify the connection.
## Add the Direct Freight service
:::note
Direct Freight uses one service. Add it as the default product code before printing labels.
:::
To add a default product code for Direct Freight:
1. Go to **Settings** > **Couriers** > **Direct Freight Settings**.
2. Click **Add a new product code**.
3. Enter **ITEM** (in capitals) as the **Product Code**.
4. Enter any description as the **Name**.
5. Click **Add**.
## Shipping and notifications
- **Rates:** Direct Freight rates include GST and the surcharges returned by Direct Freight.
- **Manifesting:** Manifest all Direct Freight shipments by 6:30 pm. Direct Freight may automatically manifest unmanifested shipments and charge a fee.
- **Notifications:** To send courier tracking notifications, go to **Settings > Couriers > Direct Freight > Advanced** and enable **Email notifications for tracking**.
## Troubleshooting
**I'm having trouble receiving tracking updates for Direct Freight. What should I do?**
If tracking updates are not coming through as expected, contact Starshipit Support. Our team can enable batch tracking for Direct Freight on your account, which may help improve tracking updates.
## Manifest or cancel a shipment
Manifest a printed shipment before redoing it with different details.
- In Classic, select the order and choose **Actions > Dispatch / Manifest**.
- In the current interface, select the order and choose **Manifest Orders**.
To cancel a manifested or archived shipment, go to **Settings > Couriers > Direct Freight > Tools**, then enter its tracking number. Cancel before 6:30 pm on the day you created the consignment to avoid a fee.
To cancel labels automatically when an order is redone or archived, enable **Automatically cancel archived orders** under **Settings > Couriers > Direct Freight > Advanced**.
## Configure Direct Freight settings
Direct Freight controls are divided between **Settings** and **Advanced**:
| Setting | What it controls |
| --- | --- |
| **Use batch tracking only** | Uses batch tracking instead of individual tracking requests. |
| **Authority To Leave** | Defaults authority to leave on shipments. |
| **Enable email notification for tracking** | Sends receiver notification details to Direct Freight when a phone number is available. |
| **Display SKUs on label** | Prints item SKUs on labels. |
| **Automatically cancel archived orders** | Cancels the Direct Freight shipment when the order is archived. |
Direct Freight uses a product code table even though it provides one label type. Add the default product code before printing labels. The **Tools** tab can cancel a shipment by tracking number.
---
# Direct Freight API Access
URL: https://support.starshipit.com/articles/5569681546895-direct-freight-api-access
Canonical: https://support.starshipit.com/articles/5569681546895-direct-freight-api-access
Markdown: https://support.starshipit.com/articles/5569681546895-direct-freight-api-access.md
Updated: 2026-05-06
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> To connect Direct Freight with Starshipit, you will need your API credentials. This guide will walk you through the process of requesting these from Direct Freight.
* To connect Direct Freight with Starshipit, you will need your API credentials.
* This guide will walk you through the process of requesting these from Direct Freight.
## Retrieve your API credentials
1. Log into the [Direct Freight Portal](https://www.directfreight.com.au/dispatch/Login.aspx).
2. Click the **Developer Centre** link at the bottom of the page.
3. On the next screen, **Click register**, then A**ccept the terms and conditions**. You will be taken to this screen:
4. Choose the above options and in the comments box write “Starshipit”. This allows Direct Freight to know that you are requesting the credentials for us.
5. From there, Direct Freight will send you the credentials. Once you receive them, follow [this guide](/articles/couriers/direct-freight/how-to-set-up-direct-freight) to integrate your Direct Freight account into Starshipit.
---
# Set up DoorDash
URL: https://support.starshipit.com/articles/12543610528911-set-up-doordash
Canonical: https://support.starshipit.com/articles/12543610528911-set-up-doordash
Markdown: https://support.starshipit.com/articles/12543610528911-set-up-doordash.md
Updated: 2026-05-06
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Step-by-step guide to setting up DoorDash.
The DoorDash integration with Starshipit allows you to take full advantage of Starshipit's features—including generating packing slips and shipping labels, auto-correcting addresses, branded tracking pages, delivery notifications, and more.
:::warning
DoorDash delivery is currently supported only for domestic deliveries in Australia and New Zealand.
:::
## Before you begin
To integrate DoorDash with Starshipit, please complete the following steps:
1. Sign an agreement with DoorDash
2. Contact the DoorDash team to let them know you'd like to integrate using Starshipit, and request your Business ID
3. Gather the following details:
* Business ID
* Business description
* Store name
4. Once you’ve collected this information, reach out to your Starshipit Sales Representative or Customer Success Manager to get your account set up. Alternatively, reach out to our [support team](https://help.starshipit.com) for help.
## How to set up DoorDash
In the Starshipit dashboard, navigate to:
1. **Settings** > **Couriers** > **Add a new courier** > **DoorDash**.
2. Tick the **Enable DoorDash** checkbox.
3. Click **Save**.
4. Navigate to the **Delivery Options** section.
5. Select your **default undeliverable action** (what DoorDash should do if delivery fails).
6. Click **Save** to confirm your selection.
## Configure DoorDash settings
The **Settings** tab includes:
| Setting | What it controls |
| --- | --- |
| **Enable DoorDash** | Enables DoorDash for eligible domestic deliveries. |
| **Use Development Credentials** | Uses DoorDash development credentials. Leave it off for live deliveries. |
| **Business ID** and **Store ID** | Identify your DoorDash business and store. DoorDash or Starshipit may populate these during onboarding. |
| **Default undeliverable action** | Chooses whether DoorDash should dispose of an undeliverable order or return it to the pickup location. |
| **Authority To Leave (contactless drop-off)** | Allows contactless drop-off on DoorDash quotes and deliveries. |
| **Signature Required (default)** | Requests signature verification at drop-off by default. |
Admins can use **Populate from Pickup Address** during onboarding to prefill the business and store details, then select **Create Store**. The onboarding form also includes Business Name, Business Description, Store Name, Store Phone, and Store Address; the phone number must use the international E.164 format and the address should be comma-separated in your local order.
---
# Set up DPD Local UK
URL: https://support.starshipit.com/articles/360001003335-set-up-dpd-local-uk
Canonical: https://support.starshipit.com/articles/360001003335-set-up-dpd-local-uk
Markdown: https://support.starshipit.com/articles/360001003335-set-up-dpd-local-uk.md
Updated: 2026-05-06
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Step-by-step guide to setting up DPD local uk.
* This article outlines how to set up DPD Local UK as a courier service in Starshipit.
## Before you begin
You will need your DPD:
* **Account Number**
Your Account number can be found in the My Account Details page under the MyDPD Local tab, after logging into the portal.
* **Username & Password**
These are the credentials used to log in to the DPD Local UK portal.
## 1. Enter your account details in Starshipit
1. In Starshipit, navigate to **Settings** > **Couriers** > **Add a new courier**.
2. Select the country you will be shipping from.
3. Select **DPD Local UK**.
4. Tick **Enable DPD Local UK**.
5. Enter your DPD details in this configuration page.
6. Click on the **Test to ensure it works** button to ensure your credentials are working correctly.
## 2. Set up parcel collection date/time
You can set up collection of packages to be a certain number of minutes from the time of printing of an order's label.
Or, you can set it to a regular daily time that you have booked with DPD Local UK. If you do this, the date can be set in the future for the next date to be used, or if it is today or was previously set and that date is now in the past, then today's date will always be used.
You can also override this setting on any individual order and the new value will be saved as the new overall setting.
:::note
You cannot set the collection date to be in the past when modifying though, and you also cannot set it to a date more than 7 days into the future.
:::
## 3. Set up advanced settings
We recommend setting up your shipper tax settings as this is required by DPD for many locations. To configure this, please read our guide [here](/articles/orders-manifests-reports/orders/set-up-shipper-tax-numbers).
Please note that DPD Local UK do not pass rates in to Starshipit, so these will not be shown in the New Orders page.
You can, however set up table rates for DPD Local UK, where you would record the rates that the courier charges you, and these can be passed back when calling the Starshipit API (although they will still not show in the New Order page).
## 4. Set up your product codes
Add your product codes to complete the integration. You can get a list of valid product codes for a destination address by using the product code finder tool in the tools tab. Known product codes are:
| | |
| --- | --- |
| 2^11 | PARCEL Two Day |
| 2^12 | PARCEL Next Day |
| 2^13 | PARCEL DPD LOCAL 12 |
| 2^08 | PARCEL DPD LOCAL 10.30 |
| 2^17 | PARCEL Saturday 12 |
| 2^09 | PARCEL Saturday 10.30 |
| 2^71 | PARCEL Saturday |
| 2^75 | PARCEL Sunday |
| 2^35 | PARCEL Sunday 10:30 |
| 2^15 | PARCEL Sunday 12 |
| 2^91 | SHIP2SHOP SHIP2SHOP |
| 2^57 | HOMECALL Homecall |
| 2^01 | EXPRESSPAK 1 Homecall |
| 2^68 | EXPRESSPAK 1 Next Day |
| 2^03 | EXPRESSPAK 1 DPD LOCAL 12 |
| 2^04 | EXPRESSPAK 1 DPD LOCAL 10.30 |
| 2^05 | EXPRESSPAK 1 Saturday 12 |
| 2^06 | EXPRESSPAK 1 Saturday 10.30 |
| 2^72 | EXPRESSPAK 1 Saturday |
| 2^76 | EXPRESSPAK 1 Sunday |
| 2^49 | EXPRESSPAK 1 Sunday 10:30 |
| 2^47 | EXPRESSPAK 1 Sunday 12 |
| 2^31 | EXPRESSPAK 5 Homecall |
| 2^32 | EXPRESSPAK 5 Next Day |
| 2^33 | EXPRESSPAK 5 DPD LOCAL 12 |
| 2^28 | EXPRESSPAK 5 DPD LOCAL 10.30 |
| 2^37 | EXPRESSPAK 5 Saturday 12 |
| 2^29 | EXPRESSPAK 5 Saturday 10.30 |
| 2^73 | EXPRESSPAK 5 Saturday |
| 2^77 | EXPRESSPAK 5 Sunday |
| 2^23 | EXPRESSPAK 5 Sunday 10:30 |
| 2^51 | EXPRESSPAK 5 Sunday 12 |
| 2^67 | FREIGHT Homecall |
| 2^82 | FREIGHT Next Day |
| 2^83 | FREIGHT By 12 |
| 2^65 | FREIGHT By 10.30 |
| 2^87 | FREIGHT Saturday By 12 |
| 2^69 | FREIGHT Saturday By 10.30 |
| 2^74 | FREIGHT Saturday |
| 2^78 | FREIGHT Sunday |
| 2^24 | FREIGHT Sunday 10:30 |
| 2^45 | FREIGHT Sunday 12 |
| 2^56 | REVERSE IT Two Day |
| 2^55 | REVERSE IT Next Day |
| 2^19 | DPD CLASSIC By Road |
| 2^10 | PARCEL BY AIR |
| 2^30 | DOCUMENT BY AIR |
| 2^70 | EUROPE BY AIR |
| 2^80 | DPD DIRECT DPD Direct |
| 2^58 | DPD DIRECT ROI DPD Direct |
| 2^60 | AIR CLASSIC Air Classic |
:::note
DPD Local doesn't pass rates into Starshipit, so these will not be displayed on the New Order page. You can, however, set up table rates for DPD Local within Starshipit, where you would record the rates that the courier charges you and retrieve these via our own API.
:::
## Configure DPD Local UK settings
The setup includes these controls:
| Setting | What it controls |
| --- | --- |
| **Default export type** | Sets the default customs purpose for international shipments. |
| **Use Staging URL** | Uses the DPD test endpoint. Leave this off for live shipments. |
| **Set pickup for an offset from now** | Schedules collection a number of minutes after printing. |
| **Set pickup for a specific date and time** | Schedules collection at the selected date and time. The date must not be in the past or more than seven days ahead. |
| **Use sender phone number if destination phone not present** | Uses the sender phone as a fallback. |
| **Duties & Taxes Paid** | Makes the sender responsible for duties and taxes by default. |
Use **Product codes** to add the services enabled on your DPD Local UK account. The **Tools** tab can look up products using a destination and parcel dimensions.
## Additional Configuration
### Submit PID Number
To send the PID number to DPD, you will need to use [UI 2.0.](https://app2.starshipit.com/)
1. Open the unshipped order.
2. In the Tax Details section on the right-hand side select **National ID** from the tax number options and enter in the ID in the text field.
3. When you print the order, this will be sent to DPD electronically for customs declarations.
---
# Set up DPD NL
URL: https://support.starshipit.com/articles/360000927735-set-up-dpd-nl
Canonical: https://support.starshipit.com/articles/360000927735-set-up-dpd-nl
Markdown: https://support.starshipit.com/articles/360000927735-set-up-dpd-nl.md
Updated: 2026-09-08
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Connect DPD NL to Starshipit, test your credentials, and add the product codes available on your account.
Connect your DPD NL account to Starshipit, test the connection, and add the product codes enabled for your account.
## Before you begin
You need these DPD NL details:
- Customer Number
- Depot Number
- User ID (Delis ID)
- User Password (Delis Password)
Contact your DPD NL account manager if you need any of these credentials.
## Connect DPD NL
1. Go to **Settings** > **Couriers** > **Add a new courier** > **DPD NL**.
2. Select **Enable DPD NL**.
3. Enter your Customer Number, Depot Number, Delis ID, and Delis Password.
4. Click **Save**.
5. Select **Test to ensure it works** to confirm your credentials are valid.
## Add product codes
Add only the product codes enabled on your DPD NL account.
| Code | Service |
| --- | --- |
| `CL` | Classic |
| `E830` | Express 08:30 |
| `E10` | Express 10:00 |
| `E12` | Express 12:00 |
| `E18` | Guarantee 18:00 |
| `IE2` | International Express |
## Configure DPD NL settings
The setup includes these controls:
| Setting | What it controls |
| --- | --- |
| **Use Staging URL** | Uses the DPD test endpoint. Leave this off for live shipments. |
| **Use Generic Description for Items** | Uses the generic item description configured under Starshipit defaults. |
| **Use sender phone number if destination phone not present** | Uses the sender phone as a fallback. |
| **Default customs terms** | Sets the default DAP, DDP, or EXW terms sent to DPD NL. |
| **Label format** | Sets the paper size and layout Starshipit uses when it creates DPD NL labels. Choose the option that matches your printer. |
Add the product codes enabled on your DPD NL account. For international shipments, select the appropriate customs terms and check the declaration details before printing.
## Verify the setup
Create or open a test order, select one of the product codes you added, and confirm the service is available before printing a label.
---
# Set up DPD UK
URL: https://support.starshipit.com/articles/360001003355-set-up-dpd-uk
Canonical: https://support.starshipit.com/articles/360001003355-set-up-dpd-uk
Markdown: https://support.starshipit.com/articles/360001003355-set-up-dpd-uk.md
Updated: 2026-05-06
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Step-by-step guide to setting up DPD uk.
* DPD UK’s [integration with Starshipit](https://www.starshipit.com/partner/dpd) allows you to use all of [Starshipit's features](https://www.starshipit.com/features) including generation of packing slips and shipping labels, auto-correction of addresses, branded tracking and notifications and many more.
* This article outlines how to set up DPD UK as a courier service in Starshipit.
### Before you begin
Before you can start setting up DPD UK in Starshipit, you will need your DPD UK credentials:
* Account Number
* Username
* Password
These are the credentials used to log in to the DPD UK portal.
Your account number can be found in **MyDPD** > **My Account Details**, after logging into the portal.
## Setting up your DPD UK in Starshipit
#### 1. Enter your account details in StarshipIt
1. In [Starshipit](https://app2.starshipit.com/), navigate to **Settings** > **Couriers** > **Add a new courier** > **DPD UK**.
2. Tick **Enable UPS**.
3. Enter your DPD UK details.
4. Click **Save**.
Click **Test to ensure it works**, to see if your credentials are working correctly.
#### 2. Set up parcel collection date/time
You can set up a collection of packages to be a certain number of minutes from the time of printing of an order's label.
Or, you can set it to a regular daily time that you have booked with DPD UK. If you do this, the date can be set in the future for the next date to be used, or if it is today or was previously set and that date is now in the past, then today's date will always be used.
You can also override this setting on any individual order and the new value will be saved as the new overall setting.
:::note
You cannot set the collection date to be in the past when modifying though, and you also cannot set it to a date more than 7 days into the future.
:::
### 3. Set up advanced settings
**Note**
* EORI Number and Shipper Destination Tax Id are only applicable for international shipments.
* DPD UK does not pass rates into StarshipIt, so these will not be shown on the New Order page.
* You can, however, set up 'table rates' for DPD UK, where you would record the rates that the courier charges you, and these can be passed back when calling the StarshipIt API (although they will still not show in the New Order page).
### 4. Set up your product codes
Add your product codes to complete the integration. You can get a list of valid product codes for a destination address by using the product code finder tool in the tools tab. Known product codes are:
| | |
| --- | --- |
| 1^11 | PARCEL Two Day |
| 1^12 | PARCEL Next Day |
| 1^13 | PARCEL DPD 12 |
| 1^14 | PARCEL DPD 10.30 |
| 1^16 | PARCEL Saturday |
| 1^17 | PARCEL Saturday 12 |
| 1^18 | PARCEL Saturday 10.30 |
| 1^01 | PARCEL Sunday |
| 1^07 | PARCEL Sunday 10:30 |
| 1^29 | PARCEL Sunday 12 |
| 1^91 | SHIP2SHOP SHIP2SHOP |
| 1^59 | HOMECALL Homecall |
| 1^32 | EXPRESSPAK Next Day |
| 1^33 | EXPRESSPAK DPD 12 |
| 1^34 | EXPRESSPAK DPD 10.30 |
| 1^36 | EXPRESSPAK Saturday |
| 1^37 | EXPRESSPAK Saturday 12 |
| 1^38 | EXPRESSPAK Saturday 10.30 |
| 1^09 | EXPRESSPAK Sunday |
| 1^23 | EXPRESSPAK Sunday 10:30 |
| 1^51 | EXPRESSPAK Sunday 12 |
| 1^41 | SWAP IT Two Day |
| 1^42 | SWAP IT Next Day |
| 1^43 | SWAP IT DPD 12 |
| 1^44 | SWAP IT DPD 10.30 |
| 1^49 | SWAP IT Afternoon |
| 1^46 | SWAP IT Saturday |
| 1^47 | SWAP IT Saturday 12 |
| 1^48 | SWAP IT Saturday 10.30 |
| 1^53 | SWAP IT Evening |
| 1^03 | SWAP IT Sunday |
| 1^05 | SWAP IT Sunday 10:30 |
| 1^04 | SWAP IT Sunday 12 |
| 1^56 | REVERSE IT Two Day |
| 1^55 | REVERSE IT Next Day |
| 1^71 | PALLET Two Day |
| 1^72 | PALLET Next Day |
| 1^73 | PALLET DPD 12 |
| 1^74 | PALLET DPD 10.30 |
| 1^76 | PALLET Saturday |
| 1^77 | PALLET Saturday 12 |
| 1^78 | PALLET Saturday 10.30 |
| 1^08 | PALLET Sunday |
| 1^28 | PALLET Sunday 10:30 |
| 1^69 | PALLET Sunday 12 |
| 1^81 | FREIGHT Two Day |
| 1^82 | FREIGHT Next Day |
| 1^83 | FREIGHT DPD 12 |
| 1^84 | FREIGHT DPD 10.30 |
| 1^86 | FREIGHT Saturday |
| 1^87 | FREIGHT Saturday 12 |
| 1^88 | FREIGHT Saturday 10.30 |
| 1^06 | FREIGHT Sunday |
| 1^24 | FREIGHT Sunday 10:30 |
| 1^31 | FREIGHT Sunday 12 |
| 1^19 | DPD CLASSIC By Road |
| 1^10 | EXPRESS Parcel by AIR |
| 1^30 | EXPRESS Document by AIR |
| 1^39 | EXPRESS PACK Classic 2-3 Days |
| 1^70 | EXPRESS Europe by AIR |
| 1^80 | DPD DIRECT DPD Direct |
| 1^58 | DPD DIRECT ROI DPD Direct |
| 1^60 | AIR CLASSIC Air Classic |
| 1^89 | FREIGHT DPD Classic |
| 1^98 | SHIP2SHOP |
| 1^99 | SHIP2SHOP |
:::note
DPD UK doesn't pass rates into Starshipit, so these will not be displayed on the New Order page. You can, however, set up table rates for DPD UK within Starshipit, where you would record the rates that the courier charges you and retrieve these via our own API.
:::
## Configure DPD UK settings
The setup includes these controls:
| Setting | What it controls |
| --- | --- |
| **Default export type** | Sets the default customs purpose for international shipments. |
| **Use Staging URL** | Uses the DPD test endpoint. Leave this off for live shipments. |
| **Set pickup for an offset from now** | Schedules collection a number of minutes after printing. |
| **Set pickup for a specific date and time** | Schedules collection at the selected date and time. The date must not be in the past or more than seven days ahead. |
| **Use sender phone number if destination phone not present** | Uses the sender phone as a fallback. |
| **Duties & Taxes Paid** | Makes the sender responsible for duties and taxes by default. |
Use **Product codes** to add the services enabled on your DPD UK account. The **Tools** tab can look up products using a destination and parcel dimensions.
## Additional Configuration
#### Submitting PID Number
To send the PID number to DPD, you will need to be using [UI 2.0.](https://app2.starshipit.com/)
1. Open the unshipped order.
2. In the Tax Details section on the right-hand side select National ID from the tax number options and enter in the ID in the text field.
3. When you print the order, this will be sent to DPD electronically for customs declarations.
---
# Configure FedEx product codes and packaging
URL: https://support.starshipit.com/articles/90200000000121-configure-fedex-product-codes-and-packaging
Canonical: https://support.starshipit.com/articles/90200000000121-configure-fedex-product-codes-and-packaging
Markdown: https://support.starshipit.com/articles/90200000000121-configure-fedex-product-codes-and-packaging.md
Updated: 2026-08-16
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Review FedEx service codes and packaging options you can configure in Starshipit.
Use FedEx product codes and packaging settings to control which FedEx services are available when you ship orders in Starshipit.
## FedEx packaging
If you do not select a FedEx packaging type, Starshipit defaults to your own packaging.
To change the packaging type, go to **Settings > Couriers > FedEx > FedEx Packaging**.
Supported FedEx packaging types include:
- FedEx 10kg Box
- FedEx 25kg Box
- FedEx Envelope
- FedEx Box
- FedEx Small Box
- FedEx Medium Box
- FedEx Large Box
- FedEx Extra Large Box
- FedEx Pak
- FedEx Tube
For size guidance, see [FedEx packaging options](https://www.fedex.com/en-nz/shipping/packaging.html#standard-packaging).
## Map imported packages to FedEx packaging
If your orders import package names or package types, map them to the matching FedEx packaging option. This lets Starshipit choose the FedEx packaging type from the package information already on the order.
1. Go to **Settings > Couriers > FedEx**.
2. In **FedEx Packaging**, select **Add mapping**.
3. Enter a **Package name** or **Package type** that your orders import.
4. Select the matching **FedEx packaging** option.
5. Add more mappings if needed, then click **Save**.
You can enter a package name, a package type, or both. A mapping applies when either value matches the package on an order.
FedEx supports one packaging type per shipment. If packages in the same shipment map to different FedEx packaging types, split them into separate shipments or update the package mappings before printing.
## FedEx product codes
Add the FedEx product codes you want to use in **Settings > Couriers > FedEx**. Available services are also listed in your FedEx settings in Starshipit.
| Code | Product name |
| --- | --- |
| EUROPE_FIRST_INTERNATIONAL_PRIORITY | Europe First International Priority |
| FEDEX_1_DAY_FREIGHT | FedEx 1 Day Freight |
| FEDEX_2_DAY | FedEx 2 Day |
| FEDEX_2_DAY_AM | FedEx 2 Day AM |
| FEDEX_2_DAY_FREIGHT | FedEx 2 Day Freight |
| FEDEX_3_DAY_FREIGHT | FedEx 3 Day Freight |
| FEDEX_CARGO_AIRPORT_TO_AIRPORT | FedEx Cargo Airport To Airport |
| FEDEX_CARGO_FREIGHT_FORWARDING | FedEx Cargo Freight Forwarding |
| FEDEX_CARGO_INTERNATIONAL_EXPRESS_FREIGHT | FedEx Cargo International Express Freight |
| FEDEX_CARGO_INTERNATIONAL_PREMIUM | FedEx Cargo International Premium |
| FEDEX_CARGO_MAIL | FedEx Cargo Mail |
| FEDEX_CARGO_REGISTERED_MAIL | FedEx Cargo Registered Mail |
| FEDEX_CARGO_SURFACE_MAIL | FedEx Cargo Surface Mail |
| FEDEX_CUSTOM_CRITICAL_AIR_EXPEDITE | FedEx Custom Critical Air Expedite |
| FEDEX_CUSTOM_CRITICAL_AIR_EXPEDITE_EXCLUSIVE_USE | FedEx Custom Critical Air Expedite Exclusive Use |
| FEDEX_CUSTOM_CRITICAL_AIR_EXPEDITE_NETWORK | FedEx Custom Critical Air Expedite Network |
| FEDEX_CUSTOM_CRITICAL_CHARTER_AIR | FedEx Custom Critical Charter Air |
| FEDEX_CUSTOM_CRITICAL_POINT_TO_POINT | FedEx Custom Critical Point To Point |
| FEDEX_CUSTOM_CRITICAL_SURFACE_EXPEDITE | FedEx Custom Critical Surface Expedite |
| FEDEX_CUSTOM_CRITICAL_SURFACE_EXPEDITE_EXCLUSIVE_USE | FedEx Custom Critical Surface Expedite Exclusive Use |
| FEDEX_CUSTOM_CRITICAL_TEMP_ASSURE_AIR | FedEx Custom Critical Temp Assure Air |
| FEDEX_CUSTOM_CRITICAL_TEMP_ASSURE_VALIDATED_AIR | FedEx Custom Critical Temp Assure Validated Air |
| FEDEX_CUSTOM_CRITICAL_WHITE_GLOVE_SERVICES | FedEx Custom Critical White Glove Services |
| FEDEX_DISTANCE_DEFERRED | FedEx Distance Deferred |
| FEDEX_EXPRESS_SAVER | FedEx Express Saver |
| FEDEX_FIRST_FREIGHT | FedEx First Freight |
| FEDEX_FREIGHT_ECONOMY | FedEx Freight Economy |
| FEDEX_FREIGHT_PRIORITY | FedEx Freight Priority |
| FEDEX_GROUND | FedEx Ground |
| FEDEX_INTERNATIONAL_CONNECT_PLUS | FedEx International Connect Plus |
| FEDEX_INTERNATIONAL_ECONOMY | FedEx International Economy |
| FEDEX_INTERNATIONAL_PRIORITY | FedEx International Priority |
| FEDEX_INTERNATIONAL_PRIORITY_EXPRESS | FedEx International Priority Express |
| FEDEX_INTERNATIONAL_PRIORITY_PLUS | FedEx International Priority Plus |
| FEDEX_NEXT_DAY_AFTERNOON | FedEx Next Day Afternoon |
| FEDEX_NEXT_DAY_EARLY_MORNING | FedEx Next Day Early Morning |
| FEDEX_NEXT_DAY_END_OF_DAY | FedEx Next Day End Of Day |
| FEDEX_NEXT_DAY_FREIGHT | FedEx Next Day Freight |
| FEDEX_NEXT_DAY_MID_MORNING | FedEx Next Day Mid Morning |
| FEDEX_REGIONAL_ECONOMY | FedEx Regional Economy |
| FEDEX_REGIONAL_ECONOMY_FREIGHT | FedEx Regional Economy Freight |
| FIRST_OVERNIGHT | First Overnight |
| GROUND_HOME_DELIVERY | Ground Home Delivery |
| INTERNATIONAL_DISTRIBUTION_FREIGHT | International Distribution Freight |
| INTERNATIONAL_ECONOMY | International Economy |
| INTERNATIONAL_ECONOMY_DISTRIBUTION | International Economy Distribution |
| INTERNATIONAL_ECONOMY_FREIGHT | International Economy Freight |
| INTERNATIONAL_FIRST | International First |
| INTERNATIONAL_GROUND | International Ground |
| INTERNATIONAL_PRIORITY | International Priority |
| INTERNATIONAL_PRIORITY_DISTRIBUTION | International Priority Distribution |
| INTERNATIONAL_PRIORITY_FREIGHT | International Priority Freight |
| PRIORITY_OVERNIGHT | Priority Overnight |
| SAME_DAY | Same Day |
| SAME_DAY_CITY | Same Day City |
| SAME_DAY_METRO_AFTERNOON | Same Day Metro Afternoon |
| SAME_DAY_METRO_MORNING | Same Day Metro Morning |
| SAME_DAY_METRO_RUSH | Same Day Metro Rush |
| SMART_POST | Smart Post |
| STANDARD_OVERNIGHT | Standard Overnight |
| TRANSBORDER_DISTRIBUTION_CONSOLIDATION | Transborder Distribution Consolidation |
## Verify product codes
Create or open a test order and check that the expected FedEx services appear in the courier options. If a service does not appear, confirm that the code is saved correctly and that the service is available for the sender and receiver address.
## Related articles
- [How to set up FedEx](/articles/couriers/fedex/how-to-set-up-fedex)
- [FedEx troubleshooting](/articles/couriers/fedex/fedex-troubleshooting)
---
# Configure FedEx returns and customs options
URL: https://support.starshipit.com/articles/90200000000123-configure-fedex-returns-and-customs-options
Canonical: https://support.starshipit.com/articles/90200000000123-configure-fedex-returns-and-customs-options
Markdown: https://support.starshipit.com/articles/90200000000123-configure-fedex-returns-and-customs-options.md
Updated: 2026-06-14
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Create FedEx return labels and configure invoice declaration, duty, tax, and sold-to address options.
Use FedEx returns and customs options when you need to create return labels or add extra commercial invoice details for international shipments.
## Returns with FedEx
You can generate a FedEx return label from an outbound shipment. FedEx return labels are not supported in the branded returns portal.
1. Go to the **Printed or Shipped** tab.
2. Select the order you want to generate a return for.
3. Go to **More actions > Create a return order**.
4. Check the shipment details.
5. Print the label or email it to the sender.
## Invoice declaration statement
Use rules when you need to add invoice declaration text only in certain scenarios.
1. Go to **Settings > Rules > Create a new Rule**.
2. Select the condition that controls when the text should apply, such as destination country.
3. Select **Set Invoice Declaration Text** as the action.
4. Enter the declaration text.
5. Click **Save**.
## Duty and tax account number
You can set a dedicated duties and taxes account number for FedEx international shipments. This account number is used when **Delivered Duty Paid** is flagged, so duties are billed to the specified account.
1. Go to **Settings > Couriers > FedEx**.
2. Tick **Delivered Duty Paid**.
3. Enter the duty and tax account details.
4. Click **Save**.
You can also set the **Duty and Tax account type** to **Seller**, **Recipient**, or **Third Party**.
## Sold-to address
Use a sold-to address for FedEx International Ground shipments when FedEx needs buyer details in the shipment request and on the commercial invoice.
1. Go to **Settings > Options > Additional Parties Customs > Add new**.
2. Select **Buyer** as the party type.
3. Add the sold-to address details.
4. Add a duties and taxes account number for the sold-to address if required.
5. Click **Save**.
When you process FedEx International Ground shipments, Starshipit sends the saved sold-to address details to FedEx.
## Verify customs settings
Create or open a test international order and generate the label documents. Check that the return, invoice declaration, duty and tax, or sold-to address details appear as expected.
## Related articles
- [How to set up FedEx](/articles/couriers/fedex/how-to-set-up-fedex)
- [FedEx additional settings](/articles/couriers/fedex/fedex-additional-settings)
- [FedEx troubleshooting](/articles/couriers/fedex/fedex-troubleshooting)
---
# Troubleshoot FedEx
URL: https://support.starshipit.com/articles/90200000000124-troubleshoot-fedex
Canonical: https://support.starshipit.com/articles/90200000000124-troubleshoot-fedex
Markdown: https://support.starshipit.com/articles/90200000000124-troubleshoot-fedex.md
Updated: 2026-06-14
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Fix common FedEx registration, product code, and image upload errors in Starshipit.
Use these checks when FedEx registration, service selection, or image upload fails in Starshipit.
## Internal Service Error during authentication
This error can appear when your FedEx street address is too long. FedEx requires the street address to be fewer than 35 characters.
1. Go to **Settings > Pickup address**.
2. Shorten the street address so it is fewer than 35 characters.
3. Save the address.
4. Go to **Settings > Couriers > FedEx**.
5. Try registration again.
## FedEx Economy does not appear
If `FEDEX_INTERNATIONAL_ECONOMY` does not return on orders, use `INTERNATIONAL_ECONOMY` as the product code instead.
After updating the product code, create or open a test order and check that the expected FedEx Economy service appears.
## Unexpected Error when uploading an image
If you see an **Unexpected Error** message when uploading a signature or letterhead image, check that sandbox mode is disabled.
1. Go to **Settings > Couriers > FedEx**.
2. Untick **Use Sandbox URL**.
3. Save your FedEx settings.
4. Upload the image again.
## Related articles
- [How to set up FedEx](/articles/couriers/fedex/how-to-set-up-fedex)
- [FedEx product codes and packaging](/articles/couriers/fedex/fedex-product-codes-and-packaging)
- [FedEx additional settings](/articles/couriers/fedex/fedex-additional-settings)
---
# Set up FedEx
URL: https://support.starshipit.com/articles/5490462577039-set-up-fedex
Canonical: https://support.starshipit.com/articles/5490462577039-set-up-fedex
Markdown: https://support.starshipit.com/articles/5490462577039-set-up-fedex.md
Updated: 2026-06-14
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Set up FedEx Express in Starshipit, validate your account, add product codes, and confirm the connection works.
Connect FedEx Express to Starshipit so you can create shipping labels, generate live rates, send tracking notifications, and write tracking details back to your sales platform.
## Before you begin
Make sure you have:
- An active FedEx account number.
- Access to the email address or phone number linked to your FedEx account.
- A complete pickup or sender address in **Settings > Pickup address**.
- The FedEx service codes you want to use in Starshipit.
- PNG files for your commercial invoice signature and letterhead if you ship internationally.
Your pickup or sender address must match the address FedEx has on your account. FedEx registration can fail if these details do not match.
## Connect FedEx
1. Go to **Settings > Couriers > Add New Courier > FedEx**.
2. Enter your FedEx account number.
3. Tick **Enable FedEx**.
4. Read and accept the End User License Agreement.
5. Check that your pickup or sender address is complete and matches your FedEx account.
6. Click **Register**.
7. Select a PIN validation method. Choose **Email**, **Phone**, or **SMS** based on the details linked to your FedEx account.
8. Click **Generate PIN**.
9. Enter the PIN and your company name, then click **Validate PIN**.
10. Click **Save**.
If validation succeeds, Starshipit populates your child key and secret. If validation fails, check your pickup or sender address, then try another PIN validation method.
## Configure FedEx services
After you connect FedEx, add the product codes for the FedEx services you want to use.
1. Go to **Settings > Couriers > FedEx**.
2. Enter the product codes you want to use.
3. Select your FedEx packaging type.
4. Upload a commercial invoice signature if you ship internationally.
5. Upload a company letterhead or logo if you ship internationally.
6. Click **Save**.
:::important
Commercial invoice signatures must be PNG files no larger than 240x25 pixels. Letterhead or logo files must be PNG files no larger than 700x50 pixels.
:::
For the full list of supported service codes and packaging options, see [FedEx product codes and packaging](/articles/couriers/fedex/fedex-product-codes-and-packaging).
## Verify the connection
After setup, confirm FedEx is ready to use.
1. Create or open a test order with a valid sender and receiver address.
2. Select a FedEx service from the courier options.
3. Generate a rate or print a test label.
4. Check that the label, tracking number, and any commercial invoice details are created correctly.
If the FedEx service does not appear, check that the product code is saved in **Settings > Couriers > FedEx**.
## Migrate from FedEx Legacy
Use the FedEx REST API integration for new FedEx setups. If your account still uses the legacy FedEx integration, migrate to the REST API integration when you are ready to update your connection.
For migration steps, see [Migrate from FedEx Legacy to FedEx REST API](/articles/couriers/fedex/migrate-fedex-legacy-to-rest-api).
## Troubleshooting
If registration, service selection, or image upload fails, check the FedEx troubleshooting guide before contacting support.
For common fixes, see [FedEx troubleshooting](/articles/couriers/fedex/fedex-troubleshooting).
## Related articles
- [FedEx product codes and packaging](/articles/couriers/fedex/fedex-product-codes-and-packaging)
- [FedEx additional settings](/articles/couriers/fedex/fedex-additional-settings)
- [FedEx returns and customs options](/articles/couriers/fedex/fedex-returns-and-customs-options)
- [Migrate from FedEx Legacy to FedEx REST API](/articles/couriers/fedex/migrate-fedex-legacy-to-rest-api)
- [FedEx troubleshooting](/articles/couriers/fedex/fedex-troubleshooting)
---
# Migrate from FedEx Legacy to FedEx REST API
URL: https://support.starshipit.com/articles/90200000000120-migrate-from-fedex-legacy-to-fedex-rest-api
Canonical: https://support.starshipit.com/articles/90200000000120-migrate-from-fedex-legacy-to-fedex-rest-api
Markdown: https://support.starshipit.com/articles/90200000000120-migrate-from-fedex-legacy-to-fedex-rest-api.md
Updated: 2026-06-14
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Move an existing FedEx Legacy courier setup to the FedEx REST API integration in Starshipit.
Move your existing FedEx Legacy setup to the FedEx REST API integration when you need to refresh your FedEx connection in Starshipit.
## Before you begin
Make sure you have:
- Your FedEx account number.
- Access to the email address or phone number linked to your FedEx account.
- A complete pickup or sender address in **Settings > Pickup address**.
- Your current FedEx product codes.
## Migrate to the REST API integration
1. Go to **Settings > Couriers > FedEx**.
2. Toggle to **REST API - New**.
3. Enter your FedEx account number.
4. Check that your pickup or sender address is complete and matches your FedEx account.
5. Click **Register**.
6. Select a PIN validation method. Choose **Email**, **Phone**, or **SMS** based on the details linked to your FedEx account.
7. Click **Generate PIN**.
8. Enter the PIN and your company name, then click **Validate PIN**.
9. Click **Save**.
If validation succeeds, Starshipit populates your child key and secret. If validation fails, check your pickup or sender address, then try another PIN validation method.
## Complete your FedEx settings
After migration, check your FedEx configuration.
1. Confirm your product codes are still saved.
2. Upload your commercial invoice signature if you ship internationally.
3. Upload your company letterhead or logo if you ship internationally.
4. Select any additional FedEx settings you use.
5. Click **Save**.
## Verify the migration
Create or open a test order, select a FedEx service, and generate a rate or label. Check that the FedEx service, label, and tracking number are created correctly.
If a FedEx service does not appear, check the product code in **Settings > Couriers > FedEx**.
## Related articles
- [How to set up FedEx](/articles/couriers/fedex/how-to-set-up-fedex)
- [FedEx product codes and packaging](/articles/couriers/fedex/fedex-product-codes-and-packaging)
- [FedEx troubleshooting](/articles/couriers/fedex/fedex-troubleshooting)
---
# Configure additional FedEx settings
URL: https://support.starshipit.com/articles/90200000000122-configure-additional-fedex-settings
Canonical: https://support.starshipit.com/articles/90200000000122-configure-additional-fedex-settings
Markdown: https://support.starshipit.com/articles/90200000000122-configure-additional-fedex-settings.md
Updated: 2026-06-14
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Configure optional FedEx settings for invoices, labels, residential addresses, drop-off types, and address validation.
Configure optional FedEx settings in Starshipit when your shipping workflow needs electronic trade documents, residential flagging, drop-off types, or enhanced address validation.
## Signature and letterhead
FedEx commercial invoices can include your signature and company letterhead.
1. Go to **Settings > Couriers > FedEx**.
2. Open the **Logos** section.
3. Upload your signature and letterhead files.
4. Click **Save**.
Signature files must be PNG files no larger than 240x25 pixels. Letterhead or logo files must be PNG files no larger than 700x50 pixels.
## Electronic trade documents
Electronic Trade Documents submit trade documents electronically to FedEx for customs clearance.
1. Go to **Settings > Couriers > FedEx**.
2. Tick **Use Electronic Trade Documents**.
3. Click **Save**.
When this setting is enabled, Starshipit creates invoices automatically when you print shipping labels.
## Order reference on labels
FedEx labels show the order number in the **ref** field by default. No extra setup is required.
## Residential flagging
Use residential flagging when FedEx orders are being sent to residential addresses.
You can set all FedEx orders as residential by default in **Settings > Couriers > FedEx**. You can also mark individual orders as residential when needed.
## Reason for export
Set a reason for export when FedEx requires export information for international shipments.
1. Go to **Settings > Couriers > FedEx > Reason for Export**.
2. Select the reason from the dropdown list.
3. Click **Save**.
## Cancel a FedEx shipment
You can cancel a FedEx shipment from the Starshipit courier tools.
1. Copy the tracking number for the shipment you want to cancel.
2. Go to **Settings > Couriers > FedEx > Tools**.
3. Enter the tracking number.
4. Click **Cancel**.
## Drop-off types
Drop-off type tells FedEx how it will receive your shipments. Available drop-off types can differ by region. Contact your FedEx account manager if you are unsure which option to use.
Available drop-off types include:
- **Regular pickup**: Your regular scheduled pickup applies.
- **Request courier**: You need to contact FedEx to request a pickup.
- **Business Service Center**: Packages are dropped off at a FedEx Business Service Center.
- **Drop Box**: Packages are dropped off at a FedEx Drop Box.
- **Station**: Packages are dropped off at a FedEx Station.
To set your default drop-off type, go to **Settings > Couriers > FedEx > Select pickup type**. This pickup type applies to all FedEx shipments.
## Enhanced address validation for US shipments
Enhanced address validation checks US receiver addresses with FedEx before label generation. If the address is valid, Starshipit generates the label. If the address is invalid, Starshipit returns an error so you can update the address.
1. Go to **Settings > Couriers > FedEx**.
2. Scroll to the bottom of the page.
3. Tick **Enable address validation for United States shipments**.
4. Click **Save**.
## Related articles
- [How to set up FedEx](/articles/couriers/fedex/how-to-set-up-fedex)
- [FedEx returns and customs options](/articles/couriers/fedex/fedex-returns-and-customs-options)
- [FedEx troubleshooting](/articles/couriers/fedex/fedex-troubleshooting)
---
# Set up FedEx International Connect (FIC)
URL: https://support.starshipit.com/articles/9710630804239-set-up-fedex-international-connect-fic
Canonical: https://support.starshipit.com/articles/9710630804239-set-up-fedex-international-connect-fic
Markdown: https://support.starshipit.com/articles/9710630804239-set-up-fedex-international-connect-fic.md
Updated: 2026-05-06
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Step-by-step guide to setting up FedEx International Connect (FIC).
* Starshipit's integration with FedEx International Connect (FIC) allows users to enjoy features such as generating packing slips and shipping labels, auto-correction of addresses, and branded tracking and notifications.
* This article provides an outline on how to set up your FedEx International Connect account in Starshipit and important information regarding product codes and package limitations.
* [Before you begin](/articles/couriers/fedex/how-to-set-up-fedex-international-connect-fic#h_01HXDHRZH2NFJ8F7H0TPHM2860)
* [How to set up FedEx International Connect](/articles/couriers/fedex/how-to-set-up-fedex-international-connect-fic#h_01HXDHSW322SXXXPGM5MJ5B419)
* [Available Products](/articles/couriers/fedex/how-to-set-up-fedex-international-connect-fic#h_01HXDHTCTFJ8WXHP6VQGPWZ506)
* [Additional Notes](/articles/couriers/fedex/how-to-set-up-fedex-international-connect-fic#h_01HXDHTQWBQ7MGCZW5HMQK4C9X)
## Before you begin
You will need your API credentials from FedEx. Contact your FedEx International Connect account manager to obtain these.
## How to set up FedEx International Connect
To enable FedEx International Connect on your Starshipit account:
1. In Starshipit, navigate to **Settings** > **Couriers**
2. Click **Add a new courier** and select **FedEx International Connect**.
3. Tick **Enable FedEx International Connect**.
4. Enter your API credentials provided by FedEx International Connect.
5. Click **Save**.
6. Add your Product codes.
## Available Products
Configure your product codes based on your shipping needs. Supported product codes include:
* TPWW (FIC - Tracked Worldwide)
* TPWP (FIC – PUDO Service)
* TPWE (FIC – Tracked USA Priority 30K)
* TPEX (FIC – Express Priority)
* TPLP (FIC – Limited Tracked +)
* TPLT (FIC – Limited Tracked)
* UK24 (UK 24 hours)
* UK48 (UK 48 hours)
* RM24 (Royal Mail Tracked 24)
* RM48 (Royal Mail Tracked 48)
* 72PT (Yodel 72 Hour Packet)
* UNTK (FIC – Untracked (UK))
:::note
Not all products may be supported in every region.
:::
## Additional Notes
* FedEx International Connect API does not support rates.
* FedEx International Connect does not support multipiece shipping. Each package requires its own label and ships independently.
---
# Set up Flash Couriers
URL: https://support.starshipit.com/articles/11280928275087-set-up-flash-couriers
Canonical: https://support.starshipit.com/articles/11280928275087-set-up-flash-couriers
Markdown: https://support.starshipit.com/articles/11280928275087-set-up-flash-couriers.md
Updated: 2026-09-03
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Step-by-step guide to setting up Flash Couriers.
Connect Flash Couriers to Starshipit to generate labels and request Australian delivery rates. This guide explains how to connect the account and arrange pickups.
## What you need to get started
Before you begin, get your **Account Code** from Flash Couriers. If you are testing, confirm whether your account code uses the test environment.
If you do not have these details, contact your Flash Couriers representative.
## Set up Flash Couriers
1. Go to **Settings** > **Couriers** > **Add a new courier**.
2. Select **Australia**, then select **Flash Couriers**.
3. Tick **Enable Flash Couriers**.
4. Enter your **Account Code**.
5. If Flash Couriers supplied test credentials, enable **Use Test Environment**. Leave it disabled for live credentials.
6. Click **Save**.
## Configure pickup scheduling
In **Pickup Settings**, choose **Pickup Scheduling Method**:
| Setting | What it does |
| --- | --- |
| **Immediately after printing** | Requests the driver immediately after a label is printed. |
| **Delayed by minutes** | Displays **Select the number of minutes after printing labels that the driver should arrive**. Enter the delay in minutes. |
| **Specific date and time** | Displays **Select the date and time the driver should arrive**. Enter the local pickup date and time. |
Click **Save** after changing the pickup method or its conditional field.
## Verify the connection
Create a test Australian shipment and confirm that the Flash Couriers service returns a rate and label. Check that the pickup request uses the schedule you selected.
---
# Set up Global-e
URL: https://support.starshipit.com/articles/10261591318415-set-up-global-e
Canonical: https://support.starshipit.com/articles/10261591318415-set-up-global-e
Markdown: https://support.starshipit.com/articles/10261591318415-set-up-global-e.md
Updated: 2026-09-03
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Step-by-step guide to setting up Global-e.
Connect Global-e to Starshipit to generate shipping labels for Global-e orders. Global-e is a cross-border commerce platform that localises storefronts and checkout for international customers.
## Before you begin
To integrate Global-e with your Starshipit account, you’ll need to be a Global-e customer. To complete the setup, you'll need the following:
* Your Global-e Merchant GUID
If you do not have this information, you can:
* Reach out to your Global-e account manager
* Contact our [support team](https://help.starshipit.com)
:::note
Important note Global-e only allows the generation of shipping labels and relevant shipping documents for orders that exist in the Global-e platform.
:::
## Set up Global-e in Starshipit
1. In Starshipit, go to **Settings** > **Couriers** > **Add a new courier**.
2. Select **Australia** as the shipping-from country, then select **Global-e** under **International**.
3. Tick **Enable Global-e**.
4. Enter your **Merchant GUID**.
5. Choose how Starshipit matches the order to Global-e:
* Enable **Order Reference (TheirRef)** to match the order reference in Global-e.
* Leave it disabled to match the **Order Number (SequenceString)** instead.
6. Enable **Use Test Environment** only when Global-e has supplied test credentials.
7. Click **Save**.
## Verify the connection
Create or import an order that exists in Global-e and confirm that Starshipit can retrieve the order and generate its shipping label. Global-e labels cannot be generated for orders that exist only in Starshipit.
### Other relevant information
You can learn more about Global-e shipping services [here](https://www.global-e.com/).
---
# Set up GoPeople
URL: https://support.starshipit.com/articles/90200000000104-set-up-gopeople
Canonical: https://support.starshipit.com/articles/90200000000104-set-up-gopeople
Markdown: https://support.starshipit.com/articles/90200000000104-set-up-gopeople.md
Updated: 2026-05-25
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Connect GoPeople to book Australian domestic courier jobs, print labels, and show live delivery prices.
Connect GoPeople to Starshipit to quote and book Australian domestic courier jobs. This guide explains what you need from GoPeople and how to add the courier to your Starshipit account.
## Before you begin
To connect GoPeople to Starshipit, you need:
* A GoPeople API access token
* Confirmation of whether you should use sandbox or live
* Any product codes you want to make available in Starshipit
If you do not have these details, contact your GoPeople account manager or visit the [GoPeople website](https://www.gopeople.com.au/).
## Set up GoPeople in Starshipit
1. In Starshipit, go to **Settings** > **Couriers** > **Add a new courier**.
2. Select **Australia** as the shipping from country.
3. Select **GoPeople**.
4. Tick **Enable GoPeople**.
5. Enter your **Access token**.
6. If GoPeople gave you sandbox credentials, tick **Use sandbox**.
7. Click **Save**.
Your GoPeople integration is now connected. You can verify the setup by creating a test shipment.
## Add product codes
GoPeople product codes are optional, but they can control which delivery services appear in Starshipit.
If you add product codes, Starshipit only shows matching GoPeople services. Use the service names or codes supplied by GoPeople.
## Limitations
* GoPeople supports domestic shipments from Australia.
* International shipping and returns are not supported through this integration.
* GoPeople labels print as 100 x 150 mm labels.
* A separate manifest step is not required.
* GoPeople can create one job and one label for a multi-parcel shipment.
## Troubleshooting
**No rates are showing?**
Check that:
* The order is an Australian domestic shipment.
* Package details are complete.
* Your access token matches the selected sandbox or live environment.
* Any product codes in Starshipit match services enabled on your GoPeople account.
**Labels are not generating?**
Check that GoPeople is enabled and the address and phone number details are complete before printing.
---
# Set up Evri
URL: https://support.starshipit.com/articles/360002196676-set-up-evri
Canonical: https://support.starshipit.com/articles/360002196676-set-up-evri
Markdown: https://support.starshipit.com/articles/360002196676-set-up-evri.md
Updated: 2026-09-03
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Step-by-step guide to setting up Evri.
Connect Evri (formerly Hermes) to Starshipit to create United Kingdom and international shipping labels and manage tracking credentials.
## Before you begin
Before you begin, ask Evri for the following credentials:
* Client ID
* Client Name
* User ID
* Password
* Tracking API Key
* Tracking Client ID
* Tracking Client Secret, if you want to use Evri tracking
You may also need the Evri product code and product name for any services you want to use. Contact Evri's integration team at [IT.Integration@hermes-europe.co.uk](mailto:IT.Integration@hermes-europe.co.uk) if you are missing these details.
If you are missing any of these credentials, please contact [Evri's integration team](mailto:IT.Integration@hermes-europe.co.uk) with your account client ID.
## Set up Evri
1. Go to **Settings** > **Couriers** > **Add a new courier**.
2. Select **United Kingdom** as the shipping-from country and choose **Evri**. Older account records may show the courier as **Hermes**.
3. Tick **Enable Evri**.
4. Enter the **Client ID**, **Client Name**, **User ID**, and **Password** supplied by Evri.
5. Enter the **Tracking API Key**, **Tracking Client ID**, and **Tracking Client Secret** if you want Starshipit to provide Evri tracking information.
6. If Evri supplied test credentials, enable **Use Staging URL**. Leave it disabled for live credentials.
7. Click **Save**.
## Add product codes
Evri does not require a product code for its default label service. Add a product code when you use one of these services, or when Evri has supplied a code for your account:
| Product Code | Product Name | Description |
| --- | --- | --- |
| 9 | French Home Deliveries | International delivery service. |
| 11 | Untracked Mail | Evri's 48-hour untracked service. |
1. Scroll to **Add product codes**.
2. Select **Add a new product code**.
3. Enter the **Code** and **Name** supplied by Evri.
4. Click **Save**.
## Configure advanced settings
Open the **Advanced** tab to set defaults for labels and notifications:
| Setting | What it does |
| --- | --- |
| **Signature Required** | Defaults shipments to require a signature. |
| **Use generic description for items** | Uses the generic item description configured under **Settings > Options** instead of the order item's description. |
| **Enable SMS Notifications** | Enables Evri SMS notifications where the service and account support them. |
Click **Save** after changing an advanced setting.
## Verify the connection
Create a test shipment with an Evri service and confirm that a label is generated. If tracking is configured, confirm that the tracking number and tracking link are returned after dispatch.
## Troubleshooting
* If Starshipit cannot save the settings, check every required credential and remove spaces copied before or after each value.
* If tracking is unavailable, recheck the three tracking credentials and confirm that Evri has enabled tracking access for your account.
* If a service is missing, add the exact product code and name provided by Evri.
---
# Set up Hived
URL: https://support.starshipit.com/articles/90200000000107-set-up-hived
Canonical: https://support.starshipit.com/articles/90200000000107-set-up-hived
Markdown: https://support.starshipit.com/articles/90200000000107-set-up-hived.md
Updated: 2026-05-25
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Connect Hived to create United Kingdom domestic labels and track shipments in Starshipit.
Connect Hived to Starshipit to create United Kingdom domestic labels and track shipments. Hived live rates are not supported in Starshipit.
## Before you begin
To connect Hived to Starshipit, you need:
* Account ID
* OAuth client ID
* OAuth client secret
* Confirmation of whether you should use sandbox or production
* Any service or product codes you want to use
If you do not have these details, contact your Hived account manager.
## Set up Hived in Starshipit
1. In Starshipit, go to **Settings** > **Couriers** > **Add a new courier**.
2. Select **United Kingdom** as the shipping from country.
3. Select **Hived**.
4. Tick **Enable Hived**.
5. Enter your **Account ID**, **Client ID**, and **Client secret**.
6. If Hived gave you sandbox credentials, tick **Use sandbox environment**.
7. Click **Save**.
Your Hived integration is now connected. You can verify the setup by creating a test shipment.
## Add product codes
Hived uses product codes to choose the delivery service. Supported codes are:
| Code | Service |
| --- | --- |
| `same_day` | Same day |
| `next_day` | Next day |
| `two_day` | Two day |
If no product code is supplied, or if the code is not recognised, Starshipit defaults to `next_day`.
## Limitations
* Hived supports domestic shipments within the United Kingdom.
* Sender and receiver countries must both be GB or UK.
* Hived supports single-package shipments only.
* Hived labels print as 100 x 150 mm labels.
* Hived live rates are not supported in Starshipit. Use configured or static shipping rules if you need to show Hived pricing at checkout or import.
* A separate manifest step is not required.
## Troubleshooting
**No rates are showing?**
This is expected. Hived live rates are not supported in Starshipit.
**Labels are not generating?**
Check that:
* Sender and receiver countries are GB or UK.
* The shipment has one package only.
* Postcodes are complete.
* Sender and receiver address details are complete.
* Package weight and dimensions are entered.
* The selected service code is one of `same_day`, `next_day`, or `two_day`.
---
# Set up Hunter Express
URL: https://support.starshipit.com/articles/115001421363-set-up-hunter-express
Canonical: https://support.starshipit.com/articles/115001421363-set-up-hunter-express
Markdown: https://support.starshipit.com/articles/115001421363-set-up-hunter-express.md
Updated: 2026-09-03
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Step-by-step guide to setting up Hunter Express.
Connect [Hunter Express](https://www.starshipit.com/partner/hunter-express) to Starshipit for domestic shipping within Australia. Choose the API version supplied by Hunter Express, then configure your services and shipment defaults.
## Before you begin
Ask your Hunter Express account manager which API to use and request the matching credentials:
* **Legacy API:** Account Code, API Username, and API Password.
* **New API:** Customer Code and Customer Name.
* Product codes and names for the services on your account.
## Set up Hunter Express
1. Go to **Settings** > **Couriers** > **Add a new courier**.
2. Select **Australia**, then select **Hunter Express**.
3. Tick **Enable Hunter Express**.
4. In **API Version**, choose **Legacy API** or **New API**.
5. Enter the credentials for the selected API. The fields change with your selection.
6. Click **Save**.
## Add product codes
1. Scroll to **Add product codes**.
2. Click **Add a new product code**.
3. Enter the code and name supplied by Hunter Express.
4. Mark the service as **Default** if it should be selected automatically.
5. Click **Save**.
## Configure advanced settings
Open the **Advanced** tab to set defaults:
| Setting | What it does |
| --- | --- |
| **Receiver Address Commercial** | Treats receiver addresses as commercial for rating. Enable this only when your shipments are to non-residential addresses. |
| **Authority To Leave** | Requests authority to leave as the default delivery option. |
| **Label Format** | Sets the paper size and layout Starshipit uses when it creates Hunter Express labels. Choose the option that matches your printer. |
Click **Save** after changing these options.
## Verify the connection
Create a test Australian shipment, select a Hunter Express product code, and confirm that a rate and label are returned.
---
# Set up IncaPost
URL: https://support.starshipit.com/articles/1788307200002-set-up-incapost
Canonical: https://support.starshipit.com/articles/1788307200002-set-up-incapost
Markdown: https://support.starshipit.com/articles/1788307200002-set-up-incapost.md
Updated: 2026-09-04
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Connect IncaPost to Starshipit for rates, labels, and tracking on supported Australian domestic lanes.
Connect IncaPost to Starshipit to get rates, print labels, and track shipments on supported Australian domestic lanes.
## Before you begin
Make sure you have:
* An active IncaPost account
* An IncaPost API key
* A sender and delivery address within IncaPost's supported service area
Contact your IncaPost account manager if you need an API key or want to confirm which locations your account can service.
## Set up IncaPost
1. In Starshipit, go to **Settings > Couriers > Add a new courier**.
2. Select **Australia** as the shipping-from country.
3. Select **IncaPost**.
4. Tick **Enable IncaPost**.
5. Enter your **API Key**.
6. Click **Save**.
## Add product codes
Product codes are optional. Leave this section empty to use all services returned for an eligible shipment, or add the services you want to use:
| Product code | Product name |
| ------------ | ------------ |
| `S` | Standard |
| `P` | Priority |
To restrict the available services:
1. Go to the **Product Codes** section.
2. Click **Add**.
3. Enter the product code and a name you will recognise.
4. Click **Save**.
The services returned for each shipment depend on the addresses, parcel weight, and your IncaPost account.
## Use delivery options
**Signature Required** and **Authority to Leave** are available from the order details page before you print a label. You can also apply these options automatically with rules.
IncaPost includes insurance automatically. You do not need to enable or configure insurance in Starshipit.
## Verify the setup
1. Create a test order using addresses within IncaPost's supported service area.
2. Get rates and confirm an IncaPost service appears.
3. Print the shipping label.
4. Confirm Starshipit saves tracking information against the order.
## Troubleshooting
### No rates are returned
Check that the API key is correct and that both addresses are within IncaPost's service area. Make sure the parcel has a valid weight.
### A label cannot be created
Check that the API key has been copied correctly and does not contain extra spaces. Confirm the delivery address and parcel details are complete, then try again.
---
# Set up InXpress
URL: https://support.starshipit.com/articles/115004654646-set-up-inxpress
Canonical: https://support.starshipit.com/articles/115004654646-set-up-inxpress
Markdown: https://support.starshipit.com/articles/115004654646-set-up-inxpress.md
Updated: 2026-09-03
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Step-by-step guide to setting up InXpress.
Connect [InXpress](https://starshipit.com/partner/inxpress) to Starshipit for domestic and international shipping in Australia and New Zealand. Enable the courier, choose how rates are handled, and enter the Webship credentials.
## Before you begin
Contact your InXpress representative and ask them to contact the [franchise support team](mailto:ecommerce.au@inxpress.com) to request the Starshipit setup. InXpress sends Starshipit a completed setup form and Starshipit confirms when the integration is ready.
Have the **Webship username** and **Webship password** from the completed setup form ready before saving.
## Set up InXpress
1. Go to **Settings** > **Couriers** > **Add a new courier**.
2. Select **Australia** or **New Zealand**, then select **InXpress**.
3. Tick **Enable InXpress**.
4. Tick **Use InXpress rates** when you want Starshipit to use the individual carrier rates returned through your InXpress account. Leave it unticked when your InXpress setup uses shared rates.
5. Enter your **Webship username** and **Webship password**.
6. Click **Save**.
## Verify the connection
Create a test shipment and confirm that an InXpress service and label are available. Rate behaviour depends on the **Use InXpress rates** selection and the services enabled by InXpress.
:::note
When using InXpress, live courier rates are not available in Starshipit or at checkout for DHL, TNT, and StarTrack services supplied through InXpress.
:::
---
# Set up Kiwi Oversize
URL: https://support.starshipit.com/articles/13668792568719-set-up-kiwi-oversize
Canonical: https://support.starshipit.com/articles/13668792568719-set-up-kiwi-oversize
Markdown: https://support.starshipit.com/articles/13668792568719-set-up-kiwi-oversize.md
Updated: 2026-09-03
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Step-by-step guide to setting up Kiwi Oversize.
Connect Kiwi Oversize to Starshipit for domestic New Zealand freight that exceeds standard parcel size or weight limits. This guide explains how to connect the account, choose label formats, and set shipment defaults.
## Before you begin
To integrate with Kiwi Oversize, you'll need to have your:
* Kiwi Oversize Account Number
* Client ID and Client Secret
If you don't have these credentials, please contact your Kiwi Oversize account manager.
## Set up Kiwi Oversize in Starshipit
To enable Kiwi Oversize as a courier in New Zealand:
1. In Starshipit, go to **Settings** > **Couriers** > **Add a new courier**.
2. Select **New Zealand** as the shipping-from country, then select **Kiwi Oversize**.
3. Tick **Enable Kiwi Oversize**.
4. Enter your **Account number**, **Client ID**, and **Client secret**.
5. Click **Save**.
## Add product codes
Kiwi Oversize currently provides one product code option:
* oversize (Oversize)
This service is designed for large, heavy, or irregular freight that cannot be sent through standard courier networks.
1. Scroll to **Add product codes**.
2. Click **Add a new product code**.
3. Enter the **Code** and **Name** supplied by Kiwi Oversize.
4. If the product code should be your default, tick the **Default** checkbox.
5. Click **Save**.
## Label formats
You can configure label formats for outbound and return labels when using Kiwi Oversize.
* **NotSet** — no default format applied
* **FreThermal** — standard 4 x 6 thermal label format
* **A4** — A4 sheet format for printing multiple labels per page
* **FreThermal174x100** — 174 x 100 mm thermal format
To configure label formats:
1. Open the **Label formats** section on the **Settings** tab.
2. Select **Format for outbound labels** and **Format for return labels**.
3. Click **Save**.
## Configure advanced settings
If required, you can also update your Advanced Settings for Kiwi Oversize.
The available Advanced Settings are:
* **Signature Required** defaults orders to signature-required delivery.
* **Saturday Delivery** defaults orders to Saturday delivery.
* **Send Notifications** enables notifications by default. The default state is determined by your settings.
* **Notification Type** selects the notification type when **Send Notifications** is enabled.
* **Mixed Packaging** enables mixed packaging for shipments where supported.
Click **Save** after changing advanced settings.
## Validate or cancel a shipment
Open the **Tools** tab to:
* Select **Test to ensure it works** to validate the saved Kiwi Oversize account credentials.
* Enter a tracking number under **Cancel a shipment** and select **Cancel shipment** to request cancellation.
## Verify the connection
Create a test domestic shipment, select the `oversize` product code, and confirm that a label is generated in the selected outbound format.
## Troubleshooting
If rates or labels are not returned, check that your credentials are correct and that the product code is enabled on your Kiwi Oversize account. If the same Client ID and Client Secret are being used for more than four accounts, contact your Kiwi Oversize account manager for help.
---
# Set up Mainfreight 2Home
URL: https://support.starshipit.com/articles/10506622692239-set-up-mainfreight-2home
Canonical: https://support.starshipit.com/articles/10506622692239-set-up-mainfreight-2home
Markdown: https://support.starshipit.com/articles/10506622692239-set-up-mainfreight-2home.md
Updated: 2026-09-03
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Step-by-step guide to setting up Mainfreight 2Home.
Starshipit is now integrated with [Mainfreight](https://starshipit.com/partner/mainfreight-shipping) 2Home in New Zealand. With Mainfreight 2Home, you can deliver directly to your customer’s door. This service is the ideal solution for delivering medium to large items to homes or businesses. It’s perfect for:
* Retail businesses delivering to homes
* Online retailers shipping from their warehouse
* Distributors
* Individuals with one-off goods to move
Mainfreight 2Home is available as a domestic courier option when shipping from New Zealand.
## Before you begin
To integrate Mainfreight 2Home with your Starshipit account, you’ll need a Mainfreight account. If you don’t have one, please get in touch with your Mainfreight account manager. To complete the setup, you will need the following information issued by Mainfreight:
* Your Mainfreight Account Code
* Your Housebill
**Prefix Registration**
The alpha prefix must be registered with Mainfreight in advance. If you did not receive it during your onboarding with Mainfreight, please get in touch with your Mainfreight account manager to obtain your registered prefix.
**Housebill Format**
The Housebill requires an alpha prefix followed by numeric characters.
* The alpha prefix must be between 2 to 4 characters.
* The numerical section must be at least 3 and no more than 12 characters.
* The total length of the Housebill, including the prefix, must not exceed 14 characters.
Here are some examples of Housebill formats:
#### Valid ✅
The numeric section following the prefix (e.g. ABC) must start and end with a one for a valid format.
* ABC101
The alpha prefix is 3 characters, the numerical section is 3 characters and starts/ends with a one.
* AB1001
The alpha prefix is 2 characters, the numerical section is 4 characters and starts/ends with a one.
#### Invalid ❌
The numeric section following the prefix (e.g. ABC) must not start with zero for a valid format.
* **A**2**B**389939
The alpha prefix is only 1 character and an invalid alpha value follows the 2.
* 1272829**BC**
The alpha prefix should be at the front of the Housebill.
* ABC**0**00001
The alpha prefix is 3 characters which is valid, however, the numerical section starts with zero, making this invalid.
* ABCD10000000001
The alpha prefix is 4 characters, the numerical section is 11 characters and starts/ends with a one which is valid, however, the total length of the Housebill exceeds 14 characters, making this invalid.
:::note
In order to secure these details, please reach out to your Mainfreight 2Home Account Manager, or M2HomeAklSales@mainfreight.com.
:::
## Setting up your Mainfreight 2Home account in Starshipit
1. In Starshipit, navigate to **Settings** > **Couriers** > **Add a new courier.**
2. Set the shipping country as **New Zealand**.
3. Select **Mainfreight** in the list of couriers.
4. Tick the **Enabled** box.
5. Enter your Mainfreight **Account Code** and **Housebill**.
6. Click **Save**.
## Add your product codes
Finally, add the product codes you’d like to use for Mainfreight:
1. In the same Mainfreight settings page from above, scroll down to the **Add product codes** section.
2. Select a product code from the **Add New Product Code** list.
3. Click **Add** to save the product code.
4. To designate a product code as your default, tick the **Default** checkbox.
For approved LCL domestic-freight accounts, you can add **LCL** or **MET**. Mainfreight keeps the routing type as **LCL** and uses the product code you select as the service level for rates and labels. Only add a code that Mainfreight has approved for your account.
## Other relevant information
You can learn more about Mainfreight2Home shipping services [here](https://www.mainfreight.com/new-zealand/en-nz/services-nz/transport/home-delivery).
---
# Netlogix
URL: https://support.starshipit.com/articles/12918634573071-netlogix
Canonical: https://support.starshipit.com/articles/12918634573071-netlogix
Markdown: https://support.starshipit.com/articles/12918634573071-netlogix.md
Updated: 2026-09-03
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> The Netlogix integration with Starshipit allows you to create shipments through Netlogixs freight management system.
Connect Netlogix to Starshipit to create freight shipments and labels through your Netlogix account. Netlogix is intended for freight rather than standard parcel shipping.
With this integration, you can generate labels and submit manifests directly to the Netlogix platform from Starshipit.
:::note
Netlogix does not currently return live rates or tracking updates through the Starshipit integration.
:::
## Before you begin
Before setting up Netlogix in Starshipit, youll need to gather your Netlogix credentials. These should be supplied by the Netlogix team or your Netlogix account manager.
Make sure you have the following details ready:
* Shipper Code
* Domain Code
* Pickup Code
This is the code assigned to your pickup location in Netlogix
* Shipper Prefix
* Your region (Australia or New Zealand)
If you don't have these details, reach out to your Netlogix account manager.
## Setting up your Netlogix account in Starshipit
## Set up Netlogix in Starshipit
1. Go to **Settings** > **Couriers** > **Add a new courier**.
2. Select **Australia** or **New Zealand** as the shipping-from country, then select **Netlogix**.
3. Tick **Enable Netlogix**.
4. Select **Netlogix Region**: **Australia** or **New Zealand**.
5. Enter the **Shipper Code**, **Domain Code**, **Pickup Code**, and **Shipper Prefix** supplied by Netlogix.
6. Click **Save**.
## Add product codes
1. In the same Netlogix settings screen, scroll down to the **Add product codes** section.
2. Click **Add a new product code**.
3. Enter the **Code** and **Name** exactly as provided by Netlogix.
4. Click **Add**.
5. Set your preferred default service by checking the **Default** box next to the product code.
Use the exact codes and names supplied by Netlogix. The default service is used when no other product code is selected.
## Verify the connection
Create a test freight shipment and confirm that a Netlogix label is generated. Netlogix does not provide a live-rate response in Starshipit, so a missing checkout rate is expected.
---
# Set up NorthLine
URL: https://support.starshipit.com/articles/90200000000103-set-up-northline
Canonical: https://support.starshipit.com/articles/90200000000103-set-up-northline
Markdown: https://support.starshipit.com/articles/90200000000103-set-up-northline.md
Updated: 2026-07-21
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Connect NorthLine to create Australian domestic labels, show live rates, and track shipments in Starshipit.
Connect NorthLine to Starshipit to create Australian domestic labels, show live rates, and track shipments. This guide explains what you need from NorthLine and how to add the courier to your Starshipit account.
## Before you begin
To connect NorthLine to Starshipit, you need these details from NorthLine:
* Account number or customer code
* Username or user code
* Password
* Product codes supplied by NorthLine
If you do not have these details, contact your NorthLine account manager.
## Set up NorthLine in Starshipit
1. In Starshipit, go to **Settings** > **Couriers** > **Add a new courier**.
2. Select **Australia** as the shipping from country.
3. Select **NorthLine**.
4. Tick **Enable NorthLine**.
5. Enter your **Account number**, **Username**, and **Password**.
6. Click **Save**.
Your NorthLine integration is now connected. You can verify the setup by creating a test shipment.
## Add product codes
NorthLine product codes are required for reliable rates and label generation. Add the product codes supplied by NorthLine in the **Add Product Codes** area.
If rates do not return, check that the order has a product code enabled on your NorthLine account. A commonly tested code is `KILO` / `Kilo`, but you should use the codes NorthLine supplied for your business.
### Add an additional service
To offer an additional service such as Tailgate Delivery, ask NorthLine for the additional-service code first. Then add a product code using your normal NorthLine product code, a plus sign, and the additional-service code. For example: `KILO+SERVICECODE`.
Starshipit uses this product code when it requests a rate and creates the label. Add the code and a clear name, then click **Save**.
## Limitations
* NorthLine supports domestic shipments from Australia.
* International shipping and returns are not supported through this integration.
* NorthLine labels print as 100 x 150 mm PDF labels.
* A separate manifest step is not required in Starshipit.
## Troubleshooting
**No rates are showing?**
Check that:
* The order is an Australian domestic shipment.
* The sender and receiver postcodes are complete.
* Package weight and dimensions are entered.
* The product code is enabled on your NorthLine account.
**Labels are not generating?**
Check that NorthLine is enabled, your credentials are correct, and the selected product code is available on your NorthLine account.
## Configure NorthLine settings
| Setting | What it does |
| --- | --- |
| Enable NorthLine | Makes NorthLine available for shipment rates and labels. |
| Account Number | Identifies your NorthLine customer account. |
| Username and Password | Authenticate requests to NorthLine. |
| Product codes | Add each NorthLine service code and name. Use `CODE+SERVICECODE` when NorthLine has given you an additional-service code, such as Tailgate. Mark the service you want to use by default. |
---
# Set up NZ Couriers
URL: https://support.starshipit.com/articles/4404567208079-set-up-nz-couriers
Canonical: https://support.starshipit.com/articles/4404567208079-set-up-nz-couriers
Markdown: https://support.starshipit.com/articles/4404567208079-set-up-nz-couriers.md
Updated: 2026-09-03
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Step-by-step guide to setting up NZ Couriers.
Connect NZ Couriers to Starshipit to create New Zealand domestic labels, show rates, manage tracking, and choose delivery defaults.
## Before you begin
To integrate with NZ Couriers you'll need to have your:
* NZ Couriers Account Number
* Client ID and Client Secret
* Any product codes and satchel codes available on your NZ Couriers account
If you don't have these credentials please contact your NZ Couriers account manager or [contact NZ Couriers via email or phone](https://www.nzcouriers.co.nz/contact.html).
## Set up NZ Couriers in Starshipit
To enable NZ Couriers as a courier in New Zealand, go to:
1. Go to **Settings** > **Couriers** > click **Add a new courier**.
2. Select **New Zealand** as the shipping-from country, then select **NZ Couriers**.
3. Tick **Enable NZ Couriers**.
4. Enter your **Account number**, **Client ID**, and **Client secret**.
5. Click **Save**.
Once you've entered and saved these details click **Test to ensure it works** to confirm that your integration is correctly set up.
## Available product codes with NZ Couriers
NZ Couriers via Starshipit can be setup with three different product code types:
**Overnight Delivery**
Overnight is the standard service offering for NZ Couriers. It can be used anywhere in New Zealand as long as NZ Couriers offers pickups and deliveries in that area.
**Two Day Delivery**
Two Day delivery is offered as an economy service for inter-island shipments. This means in Starshipit you will only see pricing for Two Day, if you have pricing loaded on your NZ Couriers account, and the shipment is inter-island (e.g. sending from Auckland to Christchurch)
**Express Pack / Satchels**
NZ Couriers offer pre-paid Express Packs (Satchels) that can be sent locally, regionally or nationally at a flat price unless you are sending to a Residential or Rural address or opt for a Saturday delivery.
Express packs used for Saturday, Residential or Rural services require an extra ticket relevant to that service.
You can learn more about the pricing of express packs [here](https://help.nzcouriers.co.nz/pricing-ticketing/price-of-express-packs).
:::note
For more information on service offerings, please visit the NZ Couriers website.
:::
## Configure NZ Couriers settings
| Setting | What it does |
| --- | --- |
| Enable NZ Couriers | Makes NZ Couriers available for shipment creation. |
| Account number, Client ID, and Client secret | Authenticate your Freightways account. |
| Product codes | Add the standard and satchel service codes available on your account and choose defaults where required. |
| Format for outbound labels and Format for return labels | Choose the paper size and layout for delivery and return labels. Select formats that work with your printer. |
| Signature Required | Applies signature as a default delivery option. |
| Saturday Delivery | Applies Saturday delivery as a default option where available. |
| Send Notifications and Notification Type | Sends tracking updates to receivers and lets you choose how they receive them. |
| Mixed Packaging | Allows mixed packaging where supported. |
| Dangerous Goods | Add up to three DG entries with commodity number, shipping name, class, packing group, cargo-aircraft and road-transport flags, radioactive/DG-LQ/marine-pollutant flags, and flashpoint. |
| Tools > Validate account | Tests the saved account credentials. |
| Tools > Cancel a shipment | Enter a tracking number to submit a cancellation. |
## Add product codes
To add the product codes you'd like to use for NZ Couriers follow these steps:
1. Scroll to **Add product codes**.
2. Select **Add a new product code**, or select **Add default product codes** to load Starshipit's defaults.
3. Enter the **Code** and **Name** supplied by NZ Couriers. Use the satchel reference list when adding prepaid Express Pack services.
4. If the product code should be your default, tick **Default**.
5. Click **Save**.
## Choose label formats
In **Label formats**, select the default **Format for outbound labels** and **Format for return labels**, then click **Save**. The available formats come from the courier settings and can include thermal and A4 options.
## Configure advanced settings
If required you can also update your Advanced Settings for NZ Couriers.
The available Advanced Settings are:
* **Signature Required** defaults all orders to signature-required delivery.
* **Saturday Delivery** defaults all orders to Saturday delivery.
* **Send Notifications** enables notifications by default. When dispatching an order, confirm that its **Send Notifications** option is selected.
* **Notification Type** selects the notification type when **Send Notifications** is enabled. Freightways may charge for SMS notifications.
* **Mixed Packaging** allows mixed packaging where supported by NZ Couriers.
Click **Save** after changing advanced settings.
## Add dangerous-goods entries
If your account is approved to ship dangerous goods, open the **Dangerous Goods** tab and select **Add new**. NZ Couriers supports up to three entries. Complete the fields below for each entry, using the product's safety data sheet:
| Field | Purpose |
| --- | --- |
| **Default** | Uses the entry when an order is marked as dangerous goods without a specific entry. |
| **Commodity Number** | Identifies the dangerous good. |
| **Proper Shipping Name** | The transport name for the material. |
| **Class**, **Packing Group** | Records the regulated classification. |
| **Cargo Aircraft**, **Road Transport**, **Radioactive**, **Dangerous Goods In Limited Quantities**, **Marine Pollutant** | Records the applicable transport flags. |
| **Flashpoint** | Records the flashpoint when applicable. |
Save the dangerous-goods entries before applying them to orders or rules.
## Validate or cancel a shipment
Open the **Tools** tab to select **Test to ensure it works** and validate the saved account credentials. To cancel a shipment, enter its **Tracking number** and select **Cancel**.
## Verify the connection
Create a test domestic shipment and confirm a rate and label are returned. If you use dangerous goods, verify that the correct default entry is applied and that the declaration information is present.
---
# Sending dangerous goods with NZ Couriers
URL: https://support.starshipit.com/articles/13813335557903-sending-dangerous-goods-with-nz-couriers
Canonical: https://support.starshipit.com/articles/13813335557903-sending-dangerous-goods-with-nz-couriers
Markdown: https://support.starshipit.com/articles/13813335557903-sending-dangerous-goods-with-nz-couriers.md
Updated: 2026-05-06
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Learn how to send dangerous goods with NZ Couriers using Starshipit.
* [Overview](/articles/couriers/post-haste/sending-dangerous-goods-with-post-haste#h_01HQP8BGKGT01WJS50GG9EA234)
* [Getting set up with NZ Couriers](/articles/couriers/post-haste/sending-dangerous-goods-with-post-haste#h_01HQP8BS6XTY3JBKG6PW3CPP5Y)
* [Adding dangerous goods in Starshipit](/articles/couriers/post-haste/sending-dangerous-goods-with-post-haste#h_01HQP8BXDCTEPMSS8BDM10W8MM)
* [Sending orders containing dangerous goods](/articles/couriers/post-haste/sending-dangerous-goods-with-post-haste#h_01HQP8C43FMX54V9V52CEQYGBS)
* [Applying dangerous goods using rules](/articles/couriers/post-haste/sending-dangerous-goods-with-post-haste#h_01HQP8CKESRV71NMPCWFV6NDVZ)
* [Printing Dangerous Goods Declaration Form](/articles/couriers/post-haste/sending-dangerous-goods-with-post-haste#h_01HQP8CQJ0F8ABF94B778Y0R4J)
* Starshipit supports sending dangerous goods with NZ Couriers. You'll need to add each dangerous good you wish to send with NZ Couriers to your Starshipit settings.
* You’ll also need to follow NZ Couriers Dangerous Goods (DG) guidelines before transport.
* After adding NZ Couriers dangerous goods to Starshipit, you can set which orders contain dangerous goods using rules or set a default dangerous goods type.
## Getting set up with NZ Couriers
To ship Dangerous Goods with NZ Couriers, first, you'll need to integrate your NZ Couriers account to Starshipit. [Follow this guide to set up NZ Couriers.](/articles/couriers/nz-couriers/how-to-set-up-nz-couriers)
## Adding dangerous goods in Starshipit
To start, you’ll need to add dangerous goods to the NZ Couriers settings page in Starshipit.
1. Go to **Settings** > **Couriers**
2. Select **NZ Couriers**
3. Go to the **Dangerous Goods** tab
4. Click **Add new** to add the dangerous goods type.
5. Add DG details for each field
*Refer to the Material Safety Data Sheet of the product if needed*
6. Click **Save** to save your changes
It is recommended that you make sure all fields are filled out for hassle-free shipping. NZ Couriers also requires the item quantity, which you can set in the weight field of the item details.
## Sending orders containing dangerous goods
If you tick the Dangerous Goods box manually on the order details page, the default dangerous good selected on the settings page will be applied.
## Applying dangerous goods using rules
Once you’ve set up dangerous goods in Starshipit, you can apply them using rules. Any rules containing a dangerous good which has not been set up in your Starshipit settings will be ignored.
To assign dangerous goods using rules follow the below steps:
1. Navigate to **Settings** > **Rules**
2. Add a new rule with any condition. E.g: SKU equals 12345
3. Select the action **Set Dangerous Goods Type**
4. Select **Value** > **NZ Couriers**
5. In the field next to **Value**, enter the identification number (UN Number/Commodity ID number) of the dangerous good you’ve set up in Starshipit.
6. On import, all details will be copied from the dangerous goods you’ve set up to the order.
## Printing Dangerous Goods Declaration Form
The DG declaration form will be automatically generated as a PDF and downloaded to your computer at the same time as the label print, using the information from the Dangerous Goods setting when the shipment is flagged for containing dangerous goods.
---
# Set up My NZ Post Business
URL: https://support.starshipit.com/articles/12337376228623-set-up-my-nz-post-business
Canonical: https://support.starshipit.com/articles/12337376228623-set-up-my-nz-post-business
Markdown: https://support.starshipit.com/articles/12337376228623-set-up-my-nz-post-business.md
Updated: 2026-09-03
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Step-by-step guide to setting up My NZ Post Business.
* Starshipit's integration with My NZ Post Business allows you to take advantage of all Starshipit's features, including integration with platforms like Shopify, generation of packing slips and shipping labels, auto-correction of addresses, branded tracking pages, tracking notifications, and more.
* My NZ Post Business is a simple and convenient solution for customers who want to send parcels with NZ Post.
* You can sign up for My NZ Post Business and start using it with Starshipit immediately. You'll just need to create an account and store a credit card within the My NZ Post Business portal.
## What you need to get started
* Your My NZ Post Business login details.
If you don't have an account, you can register [here](https://bss.nzpost.co.nz/busn-self-service/registration) using the sign-up link.
* If you're looking for a credit account through NZ Post, [click here for more details](https://www.nzpost.co.nz/mynzpost).
## How to set up My NZ Post Business
1. In Starshipit, go to **Settings > Couriers > Add New Courier**.
2. Select **New Zealand** from the **Shipping from** dropdown, then select **My NZ Post Business**.
3. Tick **Enable My NZ Post Business**.
4. Click **Authorize**. This will redirect you to the My NZ Post Business website to log in.
5. Enter your My NZ Post Business email address and password.
6. If prompted, review and accept any terms and conditions and enter your credit card details. This is required to integrate the account.
7. Once all necessary steps are completed, you will be redirected back to Starshipit.
8. Select **Lookup** to retrieve the available payment accounts.
9. Select your payment account from **Available payment accounts**.
10. Click **Save** to confirm your settings.
My NZ Post Business is now ready to use on your Starshipit account!
## Configure the settings tab
The **Settings** tab shows the account values returned by NZ Post:
* **Enable MyNZ Post Business** makes the courier available for shipping.
* **Authorize** starts or refreshes the NZ Post authorisation flow. Complete the NZ Post prompts before returning to Starshipit.
* **Account Number**, **Site ID**, and **Auth Code** are read-only values returned after authorisation. Administrators can view these values.
* **Use UAT API Endpoints** sends requests to NZ Post's test endpoints. Use this only with UAT credentials.
Click **Save** after changing the enabled or UAT setting.
## Configure advanced settings
Open the **Advanced** tab to configure shipment defaults and branding:
| Setting | What it does |
| --- | --- |
| **Signature Required (default option)** | Defaults shipments to require a signature. This cannot be enabled at the same time as Photo Required. |
| **Photo Required (default option)** | Defaults shipments to require photo confirmation. This cannot be enabled at the same time as Signature Required. |
| **Rotate Label 180 degree** | Rotates the generated label by 180 degrees. |
| **Display Customer Logo on labels** | Enables the uploaded logo on labels. The logo must be no larger than 1 MB and should be 870 px wide by 124 px high at 300 dpi. |
| **Default North Island Product** | Selects the default product for shipments from the North Island. |
| **Default South Island Product** | Selects the default product for shipments from the South Island. |
| **Format for outbound/return labels** | Selects the label dimension supplied by NZ Post. |
Select **Select** to choose a supported logo file (`PNG`, `JPEG`, `JPG`, `GIF`, `TIF`, or `EPS`), then save the advanced settings.
## Configure MyPost Business settings
On the **Settings** tab, use these controls after authorisation:
| Setting | What it does |
| --- | --- |
| **Enable My NZ Post Business** | Makes My NZ Post Business available for shipping. |
| **Merchant token** | Stores the token returned by MyPost Business authorisation. Do not replace it unless NZ Post instructs you to. |
| **Payment method** | Shows the selected payment method for the account. Use **Lookup** to retrieve available payment accounts, then select the account you want to use. |
| **Book pickups on bulk label print** | Books the next-business-day pickup between 9am and 1pm when you print labels in bulk. Each bulk print creates one pickup; Australia Post charges may apply. |
Click **Save** after changing settings. Select **Test to ensure it works** to validate the connection.
## Manage products
The **Add product codes** section controls the services available for My NZ Post Business shipments:
1. Select **Load products from MyPost Business** to load the products associated with your account, or select **Add new** to add a product manually.
2. Review the product code, product name, whether it is **International**, and whether it is the **Default** service.
3. Select **Save** to keep the product list.
4. Select **Remove all services** only when you want to remove every configured service from Starshipit.
## Configure delivery options
In **Delivery options at checkout**, configure what customers see:
* **Display transit times** shows the estimated transit time with the delivery service.
* **Delivery service description** adds a custom description to the delivery service.
Save the settings after changing either option.
## Configure advanced settings
Open the **Advanced** tab to set shipment, label, and international-shipping defaults:
| Setting | What it does |
| --- | --- |
| **Signature required** | Defaults shipments to require a signature. |
| **Enable email notification for tracking** | Enables tracking email notifications. |
| **Limit extra cover to $100** | Limits the extra-cover option to $100. |
| **Display SKUs on labels** | Prints item SKUs on labels. |
| **Enable multi-package creation for domestic shipments** | Allows domestic shipments to be created as multiple packages. MyPost bills each package as a separate consignment. |
| **Default export type** | Sets the default international export reason: Sale of Goods, Gift, Commercial Sample, Document, or Returned Goods. |
| **Default duties, taxes and fees payer** | Chooses whether the receiver pays on arrival, or the sender pays with Zonos or a tax ID. |
| **Label format (International)** | Displays the fixed international label format, **PDF A4**. |
| **Label format (Domestic)** | Sets the paper size and layout Starshipit uses for domestic labels. Choose the option that matches your printer. |
Save the advanced settings after making changes.
## Remove old basket items
On the **Tools** tab, use **Remove old items** to delete unmanifested Australia Post basket items older than the selected age. Choose the age in **Remove all unmanifested items older than**, then select **Remove old items**. Use this only for items that are no longer needed for a manifest.
## Verify the connection
Load the products, select a valid payment account, and create a test domestic shipment. Confirm that the expected product, label format, transit-time display, and tracking notification behaviour are applied.
## FAQs
**When and how are charges applied?**
Each time you print a My NZ Post Business label in Starshipit, a hold is placed on your credit card, and the charge is applied when the parcel is scanned.
**Does My NZ Post Business support international shipments?**
Yes, My NZ Post Business supports international shipments.
**How do pickups work?**
To arrange a pickup, follow these steps:
1. In Starshipit, go to the **Printed** or **Shipped** tab.
2. Select all My NZ Post Business orders you want to arrange a pickup for.
3. In the **New UI**, select ‘**Book Pickup’**, or in the **Classic UI**, select ‘**Order Pickup’** from the ‘**Actions’** dropdown.
4. Check the pickup details.
5. Click ‘**Book Pickup’** to confirm the pickup arrangement.
---
# Set up dangerous goods for NZ Post
URL: https://support.starshipit.com/articles/12196685100431-set-up-dangerous-goods-for-nz-post
Canonical: https://support.starshipit.com/articles/12196685100431-set-up-dangerous-goods-for-nz-post
Markdown: https://support.starshipit.com/articles/12196685100431-set-up-dangerous-goods-for-nz-post.md
Updated: 2026-08-26
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Step-by-step guide to setting up dangerous goods for NZ Post.
* [Overview](#h_01JPKG2S5NS9H5A6DQJG2Z7NQ3)
* [Setting up dangerous goods for NZ Post](#h_01JPKG2W9M4P4JBQXHKVD8SW03)
+ [Adding dangerous goods details](#h_01JPKG30AE84187CBGGKT3EWBJ)
+ [Sending orders containing dangerous goods](#h_01JPKG382TT498Y7X81NT00G0V)
+ [Assigning dangerous goods using rules](#h_01JPKG3PAZZ2XGQBJ7Z7P5147Z)
+ [Default dangerous goods](#h_01JPKG3SSMKGVSE5B1A7QRH2C6)
+ [Printing Dangerous Goods declaration form](#h_01JPKG3YWX5XEBWQP99WC2XA1K)
---
## Setting up dangerous goods for NZ Post
To ship dangerous goods with NZ Post, you'll first need to integrate your NZ Post Domestic & International account into Starshipit. Follow our guide on [NZ Post Domestic](/articles/couriers/nz-post/how-to-set-up-nz-post-domestic)& [NZ Post International](/articles/couriers/nz-post/how-to-set-up-nz-post-international) set-up.
:::note
Only authorized NZ Post accounts can ship dangerous goods. If your account hasn’t been enabled for DG shipments, contact your NZ Post account manager.
:::
#### **Adding dangerous goods Details**
Before shipping, you must add dangerous goods details under courier settings.
1. Go to **Settings > Couriers.**
2. Select **NZ Post Domestic** or **NZ Post International.**
3. Navigate to the **Dangerous Goods** tab.
4. Add **Signatory details** (This applies to all DG entries).
5. Click **Add new** to create a new dangerous goods type.
6. Fill in all required DG details.
* Refer to the Material Safety Data Sheet of the product if needed.
7. Click **Save.**
**Recommendation:** Ensure all fields are correctly filled out for hassle-free shipping.
:::note
Additionally, NZ Post requires DG package quantity and weight. This information will be automatically calculated based on the number and weight of packages in the shipment.
:::
---
## Sending orders containing dangerous goods
You can indicate a shipment contains dangerous goods in the following ways:
**Before you start processing (Recommended)**
To simplify the process and allow for reuse, set up a tag that exactly matches the DG UN Number:
1. In Starshipit, navigate to **Settings > Tags.**
2. Click **Add New.**
3. Enter the **UN Number** of the Dangerous Goods (DG) you want to assign, e.g., UN3081.
4. Click **Save.**
You only need one matching tag source. You can add the tag in Starshipit, or import it from Shopify when **Import Tags from Shopify** is enabled. You do not need to add the same tag in both systems.
When you use Shopify, make sure the imported tag exactly matches the UN Number configured in the NZ Post Dangerous Goods settings.
**At the order level**
1. Open the order details.
2. Go to the **Tags** section:
* Classic UI: Located below the Items section
* New UI: Located in the right panel
3. Select the **DG tag (UN Number)** you want to assign:
* Alternatively, enter the DG’s UN Number manually (Ensure the DG details are set up in the DG settings).
4. For **NZ Post Domestic only**, select the **DG add-on.**
5. Print the order.
**On print, Starshipit will automatically send the DG details matching the assigned DG tags to NZ Post Domestic & NZ Post International.**
### Assign NZ Post Domestic dangerous goods by SKU
For NZ Post Domestic in UI 2.5, you can assign a configured dangerous-goods entry to a product SKU. Use this when the same products are always dangerous goods.
1. Set up the NZ Post dangerous-goods entry first.
2. Go to **Settings > Product Catalogue** and open the product to update.
3. Assign the product's dangerous-goods type to the matching NZ Post entry, then save the product.
4. Import or open an order containing that SKU in UI 2.5.
5. Review the **Dangerous Goods** panel before printing.
Starshipit applies the mapped entry to the matching item and calculates its declared weight from the item weight and quantity being shipped. It does not include non-dangerous items or packaging weight. If multiple items use the same entry, their dangerous-goods weights are combined.
SKU mappings take precedence over order-level dangerous-goods tags. If no SKU mapping exists, Starshipit continues to use the tag or default workflow. You can review and adjust the details before printing.
---
## Assigning dangerous goods using rules
1. In Starshipit, navigate to **Settings > Rules.**
2. Click **Add New Rule.**
3. Define any condition (e.g., SKU equals 12345).
4. Select the action **‘Assign Tags’.**
5. In the **Value** dropdown, select the **DG UN Number.**
6. Click **Save.**
**Once set up, UN tags will be automatically assigned to orders meeting the conditions upon import.**
---
## Default dangerous goods
You can set one of your DG entries as the **default**. This means that:
* The details of this DG entry will be automatically passed to NZ Post when the **DG add-on** is selected for a shipment.
* This applies when no specific DG tag is assigned to the shipment.
---
## Printing Dangerous Goods Declaration Form
#### **NZ Post Domestic**
* The **Dangerous Goods Declaration Form** will be automatically generated as a PDF and downloaded to your computer when printing labels.
* The form uses the Dangerous Goods details from the Dangerous Goods settings.
* You will require two copies to be printed and signed to meet compliance standards.
#### **NZ Post International**
* **No separate** Dangerous Goods Declaration Form is generated.
* All DG details are included directly on the shipping label.
---
## FAQ
**Does my NZ Post account support sending Dangerous Goods?**
Yes, your NZ Post account must be enabled for Dangerous Goods shipping. If it is already enabled, please reach out to your account manager for confirmation.
**How do I check if my account is enabled for Dangerous Goods?**
For NZ Post Domestic, if your account is enabled, Dangerous Goods will appear as an add-on or option in your settings.
**How many Dangerous Goods products can I send in a single shipment?**
You can only send one DG product per shipment.
**What Dangerous Goods are allowed through NZ Post International?**
Currently, only the following are allowed for international shipping:
* **UN3481** – Lithium-ion batteries packed with equipment
* **UN3091** – Lithium metal batteries packed with equipment
**How do I identify if my NZ Post International shipment contains Dangerous Goods?**
If your shipment includes Dangerous Goods, the label will contain the text **ECLB** to indicate this.
---
# Request commercial access to use NZ Post with Starshipit
URL: https://support.starshipit.com/articles/4462343167119-request-commercial-access-to-use-nz-post-with-starshipit
Canonical: https://support.starshipit.com/articles/4462343167119-request-commercial-access-to-use-nz-post-with-starshipit
Markdown: https://support.starshipit.com/articles/4462343167119-request-commercial-access-to-use-nz-post-with-starshipit.md
Updated: 2026-05-06
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Learn how to request commercial access to NZ Post and connect it with Starshipit.
* Starshipit's [integration with NZ Post](https://www.starshipit.com/partner/new-zealand-post) allows you to use all of [Starshipit's features](https://www.starshipit.com/features) including generation of packing slips and shipping labels, auto-correction of addresses, branded tracking and notifications and many more.
* Starshipit is fully integrated with NZ Post services including their domestic, international and express offerings. These three services are represented as three different couriers in Starshipit:
+ NZ Post Domestic
+ NZ Post International
+ NZ Post Express
## Before you begin
To use any of these couriers on Starshipit you will need to request commercial access to the NZ Post API.
Once this has been completed you will need a Client ID and Client Secret to finish the set-up. These credentials are requested on your behalf by the Starshipit team. We will just need your Account Number, Site ID, and Permit Post Number (if applicable).
:::note
An account number starting with a 9 can be used for Domestic and International. An account number starting with a 5 can only be used for International.If you have two account numbers, check with NZ Post if one of the account numbers has a discounted pricing set up on it as this one should be used with Starshipit.
:::
## 1. Request commercial access
1. Create an account [here](https://www.nzpost.co.nz/user/register?destination=user) if you haven't already.
2. Log into your NZ Post account.
3. Go to [this link](https://www.nzpost.co.nz/user/developer-centre/register/commercial/shipping) and fill in the form to register for API commercial access.
4. Add **Starshipit Support** as your developer contact.
5. Designate Domestic and International services as the services you want.
6. Click **Submit**.
After you apply for the above, you will get an email from the NZ Post API team within 2-3 business days. It will include the steps for requesting your Client ID and Client secret, **however, you should not follow these steps and instead proceed with the next steps below.**
## 2. Send account information to Starshipit
Once your application for commercial access has been processed, send the following information to our Starshipit [support team](https://help.starshipit.com):
* Account Number(s)
* Site ID (CourierPost)
* Permit Post Number (NZ Post International, optional)
We will process an application to get your Client ID and Client secret from NZ Post on your behalf. Our team will inform you once we hear back from NZ Post.
## 3. Set up your couriers
Once Starshipit has your Client ID and Client Secret, we will also set up your required couriers on your behalf provided you have been in contact with our team.
Otherwise, if you have been given your Client ID and Client Secret by our team, you can set up each courier by yourself using the following guides:
* [NZ Post Domestic](/articles/couriers/nz-post/how-to-set-up-nz-post-domestic)
* [NZ Post International](/articles/couriers/nz-post/how-to-set-up-nz-post-international)
* [NZ Post Express](/articles/couriers/nz-post/how-to-set-up-nz-post-express)
## Other relevant information for you
To learn more about NZ Post's eShip services, [click here](https://www.nzpost.co.nz/business/sending-within-nz/parcels/shipping-solutions-for-online-sellers/eship).
For more information on NZ Post eShip and Starshipit, [click here](https://www.starshipit.com/blog-content/starshipit-v-eship-same-same-but-different).
---
# Set up NZ Post Domestic
URL: https://support.starshipit.com/articles/203806459-set-up-nz-post-domestic
Canonical: https://support.starshipit.com/articles/203806459-set-up-nz-post-domestic
Markdown: https://support.starshipit.com/articles/203806459-set-up-nz-post-domestic.md
Updated: 2026-09-03
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Step-by-step guide to setting up NZ Post domestic.
Starshipit's [integration with NZ Post](https://www.starshipit.com/partner/new-zealand-post) lets you generate packing slips and shipping labels, auto-correct addresses, send branded tracking notifications, and use other Starshipit features with your NZ Post account.
Starshipit supports NZ Post domestic, international, and express services. These are represented as separate couriers in Starshipit:
* NZ Post Domestic
* NZ Post International
* NZ Post Express
## Setting up NZ Post Domestic
### 1. Gather your NZ Post account details
Before you start, have your NZ Post **Account Number** and **Site ID** ready. You can use Starshipit's shared NZ Post connection with these details, so you do not need to request API credentials before setting up NZ Post Domestic.
If you have your own NZ Post API credentials and need to keep using them, have both your **API Key** and **API Secret** ready.
### 2. Enter your NZ Post details in Starshipit
1. Go to **Settings** > **Couriers** > **Add New Courier** > **NZ Post Domestic**.
2. Tick **Enable NZ Post Domestic**.
3. Enter your NZ Post Domestic Account Number and Site ID.
4. Under the **Location** dropdown, select your location.
5. Enter your **API Key (optional)** and **API Secret (optional)** only if you are using your own NZ Post API credentials. Leave both fields blank to use Starshipit's shared NZ Post connection.
6. Click **Save** to confirm your details.
7. Click **Test to ensure it works** to test the integration.
8. Go to the **Advanced** tab to review your other settings. When you use the shared NZ Post connection, **Print domestic labels using API** is enabled automatically.
:::important
Enter both the **API Key** and **API Secret**, or leave both blank. Entering only one credential causes a validation error. Your NZ Post **Account Number** and **Site ID** are always required.
:::
### 3. Set your default products
Once Starshipit has confirmed NZ Post Domestic is available on your account, you should check that your preferred services are configured.
1. Go to **Settings** > **Couriers** > **NZ Post Domestic** > **Settings**.
2. Click the **Advanced** tab.
3. Under **Default North Island Product** and **Default South Island Product,** select your preferred default products.
If you want to use different products per order, choose the product on each order or configure rules to assign products automatically.
For more information, see [Rules overview](/articles/notifications-branded-tracking-rules-child-accounts/business-rules/rules-overview).
To customise the name or price of an NZ Post Domestic service, including its surcharges or package pricing, see [Customise NZ Post Domestic rates](/articles/15100000000020-customise-nz-post-domestic-rates).
## Optional features
NZ Post Domestic also supports additional features such as returns and Oversize by Fliway. These are not required for the base NZ Post Domestic setup, but you can configure them if they are enabled on your NZ Post account.
### Returns with NZ Post Domestic
NZ Post offers multiple returns services such as Economy Returns, Courier Returns, and Easy Returns. To enable NZ Post Domestic returns, contact your NZ Post account manager. You can also contact our [support team](https://help.starshipit.com) and we can help get the process underway.
If you are not using Economy Returns or Courier Returns, NZ Post returns use the same product codes as outbound orders.
To set the return code you would like to use:
1. Go to **Settings** > **Couriers** > **NZ Post Domestic** > **Advanced**.
2. Enter the code in the field **Return Label Code**.
3. Click **Save**.
If you are using Economy Returns or Courier Returns, set up your returns address and default returns service in the NZ Post Domestic advanced settings. For help setting this up, contact our [support team](https://help.starshipit.com).
### Oversize by Fliway
NZ Post Domestic also supports **Oversize by Fliway** for larger domestic consignments that are too large for standard courier services.
This service is currently available through **Parcel Label API** and **eShip**. It is not available through **eCL Online**, **My NZ Post Business**, or prepaid labelling.
Key points to know:
* It is for New Zealand domestic freight only.
* It supports items from **25 kg to 60 kg**.
* Maximum dimensions are **3 m length**, **0.6 m3**, and **2.2 m height**.
* Perishable goods, liquids, and dangerous goods are not supported.
* The service is currently **non-signature only**.
* When you create the label, NZ Post automatically books a pickup with Fliway.
* Oversize items travel through the Fliway network and must be separated from your standard NZ Post freight.
Contact your NZ Post business manager if you need Oversize by Fliway enabled on your account or want the relevant **FLWY** product code added.
## Troubleshooting
#### Error message Could not authenticate comes up upon clicking the test
This is most likely due to your account not having been fully set up yet.
#### Error in getting access token
The remote server returned an error: (401) Unauthorized.
Please double-check your credentials and check for incorrect spacing. If it is still happening contact our [support team](https://help.starshipit.com).
#### NZ Post not showing on the checkout
If you have completed the set up in both courier configuration and in your eCommerce platform but NZ Post is still not showing as an option on your checkout, ensure you have **Print domestic Labels using API** enabled:
* In Starshipit, go to **Settings** > **Couriers** > **NZ Post Domestic Settings** > **Advanced**.
#### When uploading a logo to display logo on labels, I get an error "No logo uploaded"
To upload a logo to NZ Post domestic labels, you must first:
1. In Starshipit, navigate to **Settings** > **Couriers** > **NZ Post Domestic Settings**.
2. Go to the **Advanced** tab and tick the **Print domestic Labels using API** option.
3. The Onboard-MerchantLogos API endpoint on Anypoint must be required and approved on your account. Please reach out to [our team](https://help.starshipit.com) to get this approved.
## Other relevant information for you
To know more about NZ Post's eShip services, [click here](https://www.nzpost.co.nz/business/sending-within-nz/parcels/shipping-solutions-for-online-sellers/eship)
For more information on NZ Post eShip and Starshipit, [click here](https://www.starshipit.com/blog-content/starshipit-v-eship-same-same-but-different)
Starshipit supports Economy Returns and Courier Returns with NZ Post. For more information, contact our [support team](https://help.starshipit.com).
---
# Set up NZ Post International
URL: https://support.starshipit.com/articles/204485655-set-up-nz-post-international
Canonical: https://support.starshipit.com/articles/204485655-set-up-nz-post-international
Markdown: https://support.starshipit.com/articles/204485655-set-up-nz-post-international.md
Updated: 2026-08-26
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Step-by-step guide to setting up NZ Post international.
* Starshipit's [integration with NZ Post](https://www.starshipit.com/partner/new-zealand-post) allows you to use all of [Starshipit's features](https://www.starshipit.com/features) including generation of packing slips and shipping labels, auto-correction of addresses, branded tracking and notifications and many more.
* This article outlines setting up NZ Post International on your Starshipit account.
## How it works
Starshipit is fully integrated with NZ Post services including their domestic, international and express offerings. These three services are represented as three different couriers in Starshipit:
* NZ Post Domestic
* NZ Post International
* NZ Post Express
To use any of these couriers on Starshipit, you will need to request commercial access to the NZ Post API.
## Setting up NZ Post
#### 1. Request commercial access to use NZ Post with Starshipit
To use NZ Post with Starshipit, you must have commercial access to the NZ Post API.
* **If you already have commercial access:**
Please contact our [support team](https://help.starshipit.com). Our team will liaise with NZ Post on your behalf to request your respective API Key (Client ID) and API Secret (Client Secret).
* **If you don't have commercial access:**
Once you [sign up](https://bss.nzpost.co.nz/busn-self-service/) with a NZ Post account, please tell us your NZ Post Account Number. We then use this to obtain your API credentials on your behalf.
:::note
The process to request commercial access only needs to be completed once if you are setting up all three services in Starshipit and using the same account number for all three.
:::
#### 2. Enter your API details in Starshipit
Typically, this setup will be completed by the Starshipit team on your behalf. However, if you already have your API Key and API Secret and wish to complete the setup yourself, follow the steps below:
1. Go to **Settings** > **Couriers** > **Add New Courier** > **NZ Post International**.
2. Tick **Enable NZ Post International**.
3. Enter your Account Number, Client ID, and Client Secret.
4. Set your Default Export Type.
5. Click **Save**.
#### 3. Add your product codes
Once Starshipit has confirmed NZ Post International is available on your account, you should check that your preferred services are available in the courier settings.
1. Go to **Settings** > **Couriers** > **NZ Post International** > **Settings**.
2. Select your new Product Code in the Drop-down menu.
3. Click **Add**.
4. The new product code is now added.
## Returns
When you create a return from Australia to New Zealand, you’ll see eligible return services from Courier Select AU Returns (ICOUSRAUS) alongside EasyReturns.
## Use Photo Required
**Photo Required** asks NZ Post to capture a delivery photo when a parcel is left at the delivery address. It is available only when NZ Post offers it for the selected international service.
1. Open the order and select an NZ Post International service.
2. Check the delivery options for **Photo Required**.
3. Select **Photo Required** if it is available, then save or print the order.
Starshipit uses the option returned for that service and includes its charge in the quote. If you change to a service that does not offer Photo Required, the option is not available.
You can also use the existing **Photo Required (default option)** courier setting or **Set Photo Required** rule action. They apply only when the selected service supports the option. Photo Required cannot be used on a return label or together with **Signature Required**.
## Troubleshooting
#### Error: The test returns invalid accounts
Please carefully review the credentials you have entered and check for any possible errors or incorrect spaces. If you are still experiencing issues, please reach out to our [support team](https://help.starshipit.com) for further assistance.
## Other relevant information for you
To know more about NZ Post's eShip services, [click here](https://www.nzpost.co.nz/business/sending-within-nz/parcels/shipping-solutions-for-online-sellers/eship)
For more information on NZ Post eShip and Starshipit, [click here](https://www.starshipit.com/blog-content/starshipit-v-eship-same-same-but-different)
## Configure NZ Post International settings
| Setting | What it does |
| --- | --- |
| Enable NZ Post International | Makes international NZ Post services available. Use NZ Post Domestic for domestic shipments. |
| Account Number, Client ID, and Client Secret | Identify and authenticate your NZ Post International account. NZ Post Domestic API credentials can be reused when eligible. |
| Default Export Type | Sets the customs export type, such as commercial sale, e-commerce goods, returned goods, gift, commercial sample, documents, or other. |
| Product codes | Add the international services enabled on your account. Product rows include code, name, type, default, maximum weight, cover, maximum cover, and label size. |
| Permit Post Number | Supplies a permit or post number for customs where required. |
| Customs Code/HS Code | Adds the default customs code to labels. |
| Apply Label fix to main services | Applies NZ Post's label correction to the main services. |
| Use generic item descriptions | Replaces individual item descriptions with the generic package description from **Settings > Defaults**. |
| Enable Easy Returns | Enables the Easy Returns product after NZ Post has enabled it on your commercial account. |
| Generate Customs Invoice for International Orders | Generates a customs invoice for international orders. |
| Sender ABN Number | Adds the sender's Australian Business Number to customs data. |
| Non-delivery action | Choose Return at sender's cost or Abandoned / Destroy. |
| Rotate label for selected products | Selects the product codes whose labels should be rotated. |
| Dangerous goods | Add the default, UN number, shipping name, class, packing group, package type, limited-quantity, radioactive, marine-pollutant, flashpoint, Hazchem, and additional-detail values for each DG entry. |
---
# Set up NZ Post Express
URL: https://support.starshipit.com/articles/360000007935-set-up-nz-post-express
Canonical: https://support.starshipit.com/articles/360000007935-set-up-nz-post-express
Markdown: https://support.starshipit.com/articles/360000007935-set-up-nz-post-express.md
Updated: 2026-09-07
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Connect NZ Post Express to Starshipit after setting up NZ Post Domestic.
Set up NZ Post Express in Starshipit to create Express shipments. You must connect NZ Post Domestic first, because Express uses that connection.
## Before you begin
- Request commercial access to the NZ Post API. Follow [Request commercial access to use NZ Post with Starshipit](/articles/couriers/nz-post/request-commercial-access-to-use-nz-post-with-starshipit) if you do not already have access.
- Have your NZ Post **Account Number**, **Client ID**, and **Client Secret** ready.
- Set up NZ Post Domestic before continuing.
:::note
This process only needs to be completed once if you are setting up all three services in Starshipit and using the same account number for all three.
:::
## Connect NZ Post Domestic
1. Go to **Settings** > **Couriers** > **Add a new courier** > **NZ Post Domestic**.
2. Select **Enable NZ Post Domestic**.
3. Enter your **Account Number**, **Client ID**, and **Client Secret**.
4. Click **Save**.
## Connect NZ Post Express
1. Go to **Settings** > **Couriers** > **Add New Courier** > **NZ Post Express**.
2. Select **Enable NZ Post Express**.
3. Enter your **Account Number**.
4. Click **Save**.
## Configure NZ Post Express settings
NZ Post Express uses the NZ Post Domestic connection. Set up NZ Post Domestic first, then configure these Express settings.
| Setting | What it does |
| --- | --- |
| Enable NZ Post Express | Turns Express shipments on after NZ Post Domestic is connected. |
| NZ Post Express Account Number | Identifies the Express account. |
| Test to ensure it works | Checks the saved Express account details. |
| Display Customer Logo on labels | Adds the uploaded customer logo to Express labels. |
| Pickup Instructions | Adds instructions to the Express pickup request. |
| Opt out of Express notifications | Stops the sender email and receiver phone from receiving the GPS tracking link for the Express job. |
## Verify the connection
Use **Test to ensure it works** after saving the Express account details. Then create or open a test order, select NZ Post Express, and confirm the service is available before printing a label.
## Related information
- [Request commercial access to use NZ Post with Starshipit](/articles/couriers/nz-post/request-commercial-access-to-use-nz-post-with-starshipit)
- [NZ Post eShip information](https://www.nzpost.co.nz/business/sending-within-nz/parcels/shipping-solutions-for-online-sellers/eship)
---
# Set up OnSend
URL: https://support.starshipit.com/articles/90200000000082-set-up-onsend
Canonical: https://support.starshipit.com/articles/90200000000082-set-up-onsend
Markdown: https://support.starshipit.com/articles/90200000000082-set-up-onsend.md
Updated: 2026-05-06
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Step-by-step guide to setting up OnSend.
Connect OnSend to Starshipit to create shipping labels, get live rates, and track domestic parcels within New Zealand. OnSend (powered by HiTrak) specialises in large-format and homeware deliveries.
## Before you begin
To connect OnSend to your Starshipit account, you need these credentials from OnSend (HiTrak):
* API Key
* Organization Code
* Charge Account
* Charge Participant Code (your location or site code)
## Set up OnSend in Starshipit
1. In Starshipit, go to **Settings** > **Couriers** > **Add a new courier**.
2. Choose **New Zealand** as your shipping origin.
3. Select **OnSend** from the Domestic courier list.
4. Tick **Enable OnSend**.
5. Enter your **API Key**.
6. Enter your **Organization Code**.
7. Enter your **Charge Account**.
8. Enter your **Charge Participant Code**.
9. Click **Save**.
Your OnSend integration is now connected. You can verify the connection by creating a test shipment.
## Add product codes
Add the product codes available on your OnSend account in the **Add Product Codes** area.
Common OnSend product codes include:
| Code | Description |
| --- | --- |
| B2B | Business to Business deliveries |
| B2C | Business to Consumer deliveries |
| SMALLS | Smaller freight items (where agreed with OnSend) |
If a product code is missing, contact OnSend to have it enabled on your account.
## Live rates
OnSend supports live shipping rates in Starshipit. When rate lookup is enabled, you will see quoted rates from OnSend at the time of order processing.
To use live rates, make sure your OnSend account has pricing access enabled for the products you want to quote.
## Limitations
* Shipment cancellation is not supported for OnSend labels in Starshipit.
* There is no fixed public tracking URL for OnSend. Starshipit uses the tracking link returned with each shipment.
* Returns, insurance, signature on delivery, and authority to leave are not available through this integration.
## Troubleshooting
**I can't save my OnSend settings?**
Check that all required fields are filled in:
* API Key
* Organization Code
* Charge Account
* Charge Participant Code
Then try saving again.
**Labels are not generating?**
Check that OnSend is enabled and your API credentials are active. If the issue continues, contact Starshipit support with the shipment reference and any error message shown.
**Rates are not showing?**
Confirm that your OnSend account has pricing access enabled for the products you are quoting. If rates still do not appear, contact Starshipit support with an example order ID.
## Configure OnSend settings
| Setting | What it does |
| --- | --- |
| Enable OnSend | Makes OnSend available for bookings and labels. |
| API Key | Authenticates Starshipit with OnSend. |
| Organization Code | Identifies the OnSend organisation that owns the account. |
| Charge Account | Specifies the account to charge for the shipment. |
| Charge Participant Code | Identifies the charge participant or billing location. |
| Product codes | Select an existing OnSend product code from the list and add it to the courier. |
---
# Set up your own fleet or drivers in Starshipit
URL: https://support.starshipit.com/articles/9208691661967-set-up-your-own-fleet-or-drivers-in-starshipit
Canonical: https://support.starshipit.com/articles/9208691661967-set-up-your-own-fleet-or-drivers-in-starshipit
Markdown: https://support.starshipit.com/articles/9208691661967-set-up-your-own-fleet-or-drivers-in-starshipit.md
Updated: 2026-05-06
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Set up your own fleet or drivers in Starshipit alongside other delivery services.
## How it works
Plain labels in Starshipit offer an easy solution for handling orders sent via your own fleets, or for users without a courier service account. Plain labels enable you to set up your own fleets and contracted drivers directly within Starshipit, and then manage them alongside your other carriers.
Unlike labels that may have essential shipping information printed on them (typically supplied by a carrier), plain labels are completely empty, providing a blank canvas for you to add your own information.
With plain labels, you have access to many of the same fields that an integrated carrier might have – and you can tailor them to your exact needs. Here are a few examples of the fields:
* Product Name (The name you have defined for the carrier)
* Sender address
* Destination address
* Order number
* Reference Number
* Weight: Total weight of the package
* SKUs: A list of the SKUs on the shipment
* Delivery Instructions
* Barcode
Read our support guide [here](/articles/couriers/plain-label/how-to-use-plain-labels) to see the full list of customisable fields and to learn how to set up plain labels in Starshipit.
## Locate2u
Our integration with Locate2u enables you to send your own delivery shipments to Locate2u, allowing you to allocate them to drivers and optimise the best delivery routes through the Locate2u platform.
Read our support guide [here](/articles/integrations/accounting-other-platforms/how-to-set-up-locate2u) to learn how to integrate with Locate2u.
## Orca Scan
Our integration with Orca Scan enables drivers to scan the barcodes on shipping labels using a smartphone. Then, Orca Scan will send the tracking update to Starshipit.
### Using Orca Scan with Starshipit
Orca Scan enables users to quickly scan barcodes (like shipping labels) using a smartphone, capturing and exporting data to various formats for easy analysis. You can [set up Orca Scan](/articles/integrations/accounting-other-platforms/how-to-update-tracking-with-plain-labels-using-orca-scan) to work with Starshipit.
When using your own fleets (with plain labels), drivers can use Orca Scan to update the delivery status of the orders they’re delivering. For example, when they deliver a package, they can scan the barcode on the shipping label using Orca Scan, which then updates the status in Starshipit.
This will trigger the same email notifications in Starshipit as if you were using another carrier. It will also add the same delivery time stamps to your reports, so you can track the performance of your own fleets.
### Typical workflow using plain labels and Orca Scan with Starshipit
1. Set up plain labels in Starshipit.
2. Set up Orca Scan and create a sheet.
3. Link Orca Scan and Starshipit.
4. Print a plain label from Starshipit.
5. Delivery driver opens the Orca Scan app on a mobile device, scans the barcode and updates the status.
6. Status is automatically updated in Starshipit.
### How to get started
Getting started using your own fleets and drivers is as easy as setting up a plain label and the Orca Scan app. Read our comprehensive step-by-step guide here:
* [How to update tracking with plain labels (Using Orca Scan)](/articles/integrations/accounting-other-platforms/how-to-update-tracking-with-plain-labels-using-orca-scan)
---
# Set up Parcel Right
URL: https://support.starshipit.com/articles/11107320888463-set-up-parcel-right
Canonical: https://support.starshipit.com/articles/11107320888463-set-up-parcel-right
Markdown: https://support.starshipit.com/articles/11107320888463-set-up-parcel-right.md
Updated: 2026-05-06
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Step-by-step guide to setting up Parcel Right.
Starshipit is now integrated with Parcel Right (formerly DAI Post), an Australian domestic shipping service that focuses exclusively on domestic shipments within Australia. Learn more about [Parcel Right shipping services](https://www.daipost.com/).
## Before you begin
To connect Parcel Right with your Starshipit account, you’ll need your:
* Parcel Right User ID
* Password
If you do not have these credentials, please contact your Parcel Right account manager.
## Setting up your Parcel Right account
1. In Starshipit, navigate to **Settings > Couriers > Add a new courier.**
2. Select **Australia** from the **Shipping From** dropdown.
3. Select **Parcel Right** under the Australian Domestic section.
4. Tick **Enable Parcel Right.**
5. Enter your **Parcel Right User ID** and **Password.**
6. Select an **Origin Terminal** from which shipments will be uplifted.
7. Click **Save** to save your integration details.
## Add your product codes
Finally, add the product codes you'd like to use for Parcel Right:
1. Navigate to the **Product Codes** section.
2. Select a product code from the **Add New Product Code** dropdown list.
3. Click **Add** to save the selected product code.
:::note
If you want a specific product code to be set as your default, make sure to tick the Defaultcheckbox beside the product code before saving.
:::
## FAQs
**Does Parcel Right support both domestic and international shipping?**
No, Parcel Right currently supports only Australian domestic shipments.
**Does Parcel Right support multi-package shipments?**
No, Parcel Right does not support multi-package shipments/orders at this time.
**Is a manifest compulsory for Parcel Right shipments?**
No, generating a manifest is optional for Parcel Right shipments.
## Configure Parcel Right settings
| Setting | What it does |
| --- | --- |
| Enable Parcel Right | Makes Parcel Right available for shipment creation. |
| User ID and Password | Authenticate your Parcel Right account. |
| Origin Terminal | Select the Parcel Right terminal from which shipments leave. |
| Use Test Environment | Uses the Parcel Right test environment. Keep this off for live shipments. |
| Product codes | Select the product codes enabled on your Parcel Right account, then add them to Starshipit and choose a default where needed. |
| Tools > Cancel a Shipment | Enter a Parcel Right tracking number to submit a cancellation. |
---
# Set up Parcelpoint (Powered by Asendia)
URL: https://support.starshipit.com/articles/11107303945231-set-up-parcelpoint-powered-by-asendia
Canonical: https://support.starshipit.com/articles/11107303945231-set-up-parcelpoint-powered-by-asendia
Markdown: https://support.starshipit.com/articles/11107303945231-set-up-parcelpoint-powered-by-asendia.md
Updated: 2026-05-06
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Step-by-step guide to setting up Parcelpoint (powered by Asendia).
* Parcelpoint (previously Hubbed), powered by Asendia, is a network of over 2,000 drop-off locations across Australia, including pharmacies, petrol stations, newsagents, and retail stores.
* This service offers fully tracked international parcel delivery, helping our user brand’s reach worldwide with ease and confidence, which offers international shipping services to a range of countries.
* This article outlines additional details about how to integrate Parcelpoint Asendia with your Starshipit account.
* You can find a list of supported countries [here](#h_01JCF0X0VPZRZMR7F58NM5PFER).
## Before you begin
:::warning
Parcelpoint, powered by Asendia, only supportsAsendia e-PAQ Select,where merchants can drop off shipments at Parcelpoint Asendia locations. This does not include shipments where Asendia provides parcel pickup services from merchants' locations.
:::
To connect Parcelpoint Asendia with your Starshipit account, you’ll need your **Parcelpoint Asendia API Key**.
If you don’t have these credentials, please get in touch with your Parcelpoint Asendia account manager. If you do not have an account manager, please email the [Parcelpoint Asendia sales team](mailto:sales@hubbed.com).
## How to set up Parcelpoint Asendia
1. In Starshipit, navigate to **Settings > Couriers > Add a new courier**.
2. Select **Parcelpoint Asendia** under the International section.
3. Tick **Enable Parcelpoint Asendia.**
4. Enter your **Parcelpoint Asendia API Key.**
5. Click **Save** to save your integration details.
:::note
Learn more about Parcelpoint Asendia's eCommerce shipping services [here](https://parcelpoint.com.au/).
:::
## FAQs
**Does Parcelpoint support domestic shipping?**
No, Parcelpoint Asendia currently supports only international shipments.
**Does Parcelpoint support shipments to all countries?**
Currently, only shipments from Australia to the USA, Canada, United Kingdon, New Zealand, Malaysia, Phillipines, Thailand and Singapore are supported. For a full list of countries and options, please contact [Asendia](https://www.asendia.com/e-paq/e-paq-select) directly.
**Why doesn’t the destination on my label match the destination address of the order?**
The address on the label is for a Parcelpoint Asendia location. Once parcels are dropped off, they are sent to a Parcelpoint Asendia processing centre, where they are relabelled with the final destination details.
**Are Asendia shipments processed as DDP or DDU?**
All shipments processed are DDP (Delivered Duty Paid).
**How do I obtain a commercial invoice to include with my shipment?**
For Asendia shipments, a commercial invoice isn’t necessary. Shipment details are electronically passed to customs by Asendia.
**Does Parcelpoint support multi-package shipments?**
Yes, Parcelpoint Asendia supports multi-package shipments/orders.
## Configure Parcelpoint Asendia settings
| Setting | What it does |
| --- | --- |
| Enable Parcelpoint Asendia | Makes Parcelpoint available as a delivery option. |
| API Key | Authenticates the connection. Get this from Parcelpoint or Asendia. |
---
# Set up Parxl
URL: https://support.starshipit.com/articles/11107347958031-set-up-parxl
Canonical: https://support.starshipit.com/articles/11107347958031-set-up-parxl
Markdown: https://support.starshipit.com/articles/11107347958031-set-up-parxl.md
Updated: 2026-05-06
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Step-by-step guide to setting up Parxl.
* Starshipit is now integrated with Parxl (by Singapore Airlines).
* Parxl offers international shipping services to various countries worldwide.
* You can find a list of supported countries listed below.
* This article outlines how you can integrate with Parxl using Starshipit.
## Before you begin
To integrate Parxl with your Starshipit account, you’ll need your Parxl Merchant Name and Secret API Key.
If you don’t have these credentials, please get in touch with your Parxl account manager. If you do not have an account manager, please visit the [Parxl website](https://parxl.com/) to contact the Parxl team.
## How to set up Parxl
1. In Starshipit, navigate to **Settings** > **Couriers** > **Add a new courier**.
2. Select Parxl (by Singapore Airlines) under the International section.
3. Tick **Enable Parxl**.
4. Enter your **Merchant Name** and **Secret Key**.
5. Click **Save** to save your integration details.
:::note
You can learn more about eCommerce shipping services by Parxl here.
:::
## FAQ
**Which countries are supported by Parxl?**
* US – United States
* CA – Canada
* JP – Japan
* TW – Taiwan
* GB – United Kingdom
* NZ – New Zealand
* PH – Philippines
* SG – Singapore
* MY – Malaysia
* KR – South Korea
* AU – Australia
* HK – Hong Kong
**Does Parxl support international shipping?**
Yes, Parxl exclusively supports international shipping.
**Does Parxl support multi-package shipments?**
No, Parxl only supports single-package shipments at this time.
**How can I get a commercial invoice?**
Parxl does not return a commercial invoice with the label. Any necessary documentation for export/import customs clearance will be generated by the Parxl system if needed and shared with the relevant partners, such as customs broker agents.
**Does Parxl support pickups?**
Yes, Parxl supports pickups. A separate pickup request is not needed, as all shipments are created with pickup required by default.
**What service options are supported via Starshipit?**
Parxl offers service options including "postal," "self-collect," and "standard." However, all Starshipit shipments default to the "standard" option.
**Are Starshipit shipments created as DDU or DDP?**
Starshipit supports both DDP and DDU with ParXL. Learn more here: [Configuring your shipment's DDP/DDU](/articles/international-shipping-compliance/customs-duties/configuring-your-shipment-s-ddp-ddu)
## Configure Parxl settings
| Setting | What it does |
| --- | --- |
| Enable Parxl | Makes Parxl available for shipment creation. |
| Merchant Name | Identifies your Parxl merchant account. |
| Secret Key | Authenticates requests to Parxl. |
| Use Staging URL | Uses the Parxl test endpoint. Keep this off for live shipments. |
---
# Set up PBT
URL: https://support.starshipit.com/articles/5089165946127-set-up-pbt
Canonical: https://support.starshipit.com/articles/5089165946127-set-up-pbt
Markdown: https://support.starshipit.com/articles/5089165946127-set-up-pbt.md
Updated: 2026-05-06
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Step-by-step guide to setting up PBT.
* PBT's integration with Starshipit allows you to use all of [Starshipit's features](https://starshipit.com/partner/pbt) including generation of packing slips and shipping labels, auto-correction of addresses, branded tracking and notifications and many more.
* This article outlines how to set up PBT as a courier service in Starshipit.
## What you need to get started
Before getting started with PBT you will need:
* Your PBT account number
* Your PBT API key. If you do not have this already, you can contact PBT and ask to be integrated with Starshipit. Alternatively, reach out to Starshipit and we can help with this process
## How to set up PBT
1. In Starshipit, navigate to **Settings** > **Couriers** > **Add a new courier** > **PBT**.
2. Enter your **PBT account number.**
3. Enter in the PBT **API key** you were provided.
4. Click **Save**.
5. Set up your PBT services by adding the **product codes**.
## Supported services
Starshipit supports PBT Standard Courier and Satchel services.
* PBT Couriers - Standard Couriers
* DLE - DLE Overnight
* A5 - A5 Overnight
* A4 - A4 Overnight
* A3 - A3 Overnight
* LRG - LRG Overnight
## Additional Configuration
**Rates**: PBT Standard Courier rate and PBT Satchel services are supported in Starshipit - Transport rates are not supported at this time.
**Label Format**: Currently, PBT only supports 100X150 labels via their API. PBT One only has 100X170 labels so if using an integrated partner, ensure you have the correct labels for this smaller format.
**Billing**: You will be charged by PBT when a RunSheet is submitted.
## Configure PBT settings
| Setting | What it does |
| --- | --- |
| Enable PBT | Makes PBT available for shipment creation. |
| Account ID | Identifies your PBT account. |
| API key | Authenticates the API-based PBT connection. |
| Use UAT Environment | Uses PBT's test environment for API requests. |
| Prefix code and File code | Maintain the identifiers used by legacy PBT accounts. These fields appear only for the legacy settings model. |
| Consignment increment | Sets the next consignment number for the legacy flow. |
| Runsheet increment | Sets the next runsheet number for the legacy flow. |
| Use large labels | Requests the larger PBT label format where supported. |
| Product codes | Add the services enabled on your PBT account. |
---
# Use plain labels
URL: https://support.starshipit.com/articles/204697995-use-plain-labels
Canonical: https://support.starshipit.com/articles/204697995-use-plain-labels
Markdown: https://support.starshipit.com/articles/204697995-use-plain-labels.md
Updated: 2026-03-06
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Learn how to use plain labels.
Plain labels let you ship orders through Starshipit without a courier API integration. Use them for non-integrated carriers, in-house drivers, store transfers, pickup-in-store orders, or testing your setup.
## What are plain labels?
Plain labels, also known as blank shipping labels or blank address labels, are adhesive labels that come without any pre-printed content. Unlike labels that may have essential shipping information printed on them (typically supplied by a carrier), blank labels are completely empty, providing a blank canvas for you to add your own information.
## Why use plain labels?
Orders printed with a plain label will be treated the same as your orders via integrated couriers in your account. Your eCommerce platform will be updated with the correct details, you can send email notifications and they will be included in your reports.
Non-Integrated Couriers: For couriers that don't have an API integration available for Starshipit, such as Australia Post prepaid satchels, using plain labels is an easy solution. It allows you to create address labels for your satchels.
Test Courier: Plain labels are an ideal choice when you want to test the functionality of Starshipit's shipping system without booking shipments with a live courier service.
Non-supported couriers: In situations where certain courier services are not natively integrated with Starshipit, plain labels offer a convenient workaround. This allows you to use Starshipit's platform while still accommodating shipments through various non-integrated couriers.
Using your own drivers: If your business operates with in-house or dedicated delivery drivers, plain labels come in handy. You can generate shipping labels for orders filled by your own drivers, facilitating efficient order tracking and delivery management.
Envelope service: For envelope services (i.e. AusPost mail) where a branded label is not necessary, you can save time by printing a plain label to stick on the envelope instead of handwriting it.
Pick up in store: You can pack the order and stick this label on the front so its clear to your team who the order belongs to for when they come and pick it up.
Store transfers: You can offer additional information and context about the order being sent to the receiving store, allowing them to better prepare for its arrival and ensure a smooth transfer process.
## Set up your plain label
### Initial set up
1. In Starshipit, navigate to **Settings** > **Couriers**.
2. Click **Add a new courier**.
3. Under **Other**, select **Plain Label**.
4. Select **Enable a plain label**.
5. Enter the name of your carrier.
6. Optional Additional Configuration:
1. **Enter a tracking URL:** This URL is used as the tracking URL in the customer notifications
2. **Specify a custom message to write back when there's no tracking number:** If no tracking number is entered when shipping the order, this value will be used
3. **Hide sender address**
4. **Hide barcode**
5. **Show receiver phone number:**Only available on A4 and 100X150mm plain labels
6. **Display item SKUs on labels**: Displays your item SKUs on labels
7. Select paper size. The most common is 100x150 which is the same size as courier company labels.
8. Click **Save**.
### Customise the plain label template
Starshipit automatically generates a shipping label for your order, incorporating both the order information and your predefined settings. However, if you prefer a personalized touch, our flexible template editor allows you to create your own label design.
1. In Starshipit, navigate to **Settings** > **Couriers** > **Plain Label** > **Label Template**.
2. Select **Customise your own**,
3. From here, you can either use the template editor for modifications. Alternatively, export the template to edit in Microsoft Excel.
4. When you have completed your edits, click the save template button.
### Changing the logo
1. Upload your logo and click **Save logo**.
2. In the editor, use the [Logo] variable to add the logo to your template.
3. Once you have completed your changes, click **Save template**.
### Changing the font size, colour, and type
* Highlight the text and variables you wish to modify in the template.
* Use the toolbar options to adjust the font size, colour, and type. Tailor these elements to enhance readability and efficiency in your packing process.
### Including and excluding information
* The right-hand side panel displays various variables for inclusion in your template. These variables auto-populate with the corresponding data upon label generation. Add them wherever required to the template
* Remove any unwanted data by simply deleting it from the template.
* The data included does not need to be a variable. Include any custom text on the label by typing directly into the template.
### Rearranging template elements
Feel free to reposition or update any component of the template, similar to standard template editing tools.
All variables:
* ProductName: The name you have defined for the carrier
* SenderAddress
* DestinationAddress
* CurrentDate
* OrderNumber
* XofY: This will display package 1 of 1
* Reference Number
* Weight: Total weight of the package
* SKUs: A list of the SKUs on the shipment
* Delivery Instructions
* ShippingMethod
* ShippingDescription
* PackageDimensions
* PrintedDate
* ItemDescription
* CompanyName
* PackageDimensions: i.e 10x10x10
* PackageName
* [Barcode]: a barcode representation of the order number
### Loading custom rates
Custom rates allow you to set shipping rates for plain label couriers, ensuring the cheapest carrier is accurately determined. These rates are displayed in the user interface, used when calculating the cheapest carrier and stored for generating shipping price reports, specific to each courier.
You can define rates based on a combination of destination (Country Codes, State Codes, Post Codes) and weight conditions. Mandatory fields include Product Code and Product Name.
1. Go to **Settings** > **Couriers**.
2. Click on **Plain Label.**
3. Navigate to the **Custom Rates** tab.
4. Configure your table rate:
* Enter the countries/states and postcodes to which you want this rate to apply.
* In the shipping rates field, enter the rates in the following format: From Weight | Price.
* For example, if you want all orders between 0-500 grams to cost $5, and orders from 500 grams to 1 kg to cost $7.5, you should configure it like this:
0.5 | 5
1 | 7.5
5. For more detailed instructions on configuring table rates, refer to [our comprehensive guide.](/articles/rates-at-checkout/set-up-guides/set-up-table-rates)
6. Click **Save**
### Advanced configuration
Use the Reference field on the label (as opposed to Order Number): Choose whether you'd like to have your order number or the reference number printed on the shipping label
Enable Postage Paid Stamp for Australia Post/Postage Paid Priority Stamp for Australia Post: This will mean the Postage Paid or Postage Paid Priority imprint is automatically added to your plain labels.
Authority To Leave: Allow your parcel to be left somewhere safe, without a signature.
Signature Required: A signature will be required upon delivery.
Generate Commercial invoice for international orders: Enable this to allow the automatic generation of a commercial invoice for your plain-label shipments that include all relevant customs information. To ensure automatic printing, please assign "Plain Label A4 Customs" to your desired printer. If you have multiple plain label couriers you will need to set up the label settings for each plain label courier.
## Processing your shipments with plain labels
Processing orders with plain labels in Starshipit is a straightforward process, similar to handling other shipments. Plain labels will appear as a carrier option on the order, allowing you to choose them when processing shipments.
1. Consider [setting up a rule](/articles/notifications-branded-tracking-rules-child-accounts/business-rules/rules-overview) to automatically assign some orders to plain labels.
2. You will see plain label as a courier option in line with your other integrated couriers.
3. If you have tracking to associate with the order, open the order and either scan or manually enter the tracking number in the tracking number field.
4. When ready, **[print your labels.](/articles/printing-labels-packing-slips/printing/about-printing-and-labels)**
5. The order will moved to printed automatically and your ecommerce store will be updated to say the order is fulfilled.
:::note
When scanning Australia Post prepaid satchels/labels, you need to use a barcode scanner which supports scanning 2D barcodes.
:::
## FAQs
How many plain-label couriers can I add to my account?
Starshipit allows 5 plain labels per account.
Can I send email or SMS notifications with plain labels?
Yes, notifications are sent when using a plain-label courier. These are only available on a paid plan.
How many rates can I load per plain label?
At this time only one rate per plain label is supported.
Can I generate commercial invoices for plain labels?
Yes. Enable this from the advanced settings section to ensure commercial invoices are automatically generated when you print plain label shipments.
What fields are supported on plain labels?
The current supported fields are:
* Sender address
* Receiver address (including phone number)
* Item SKUs
* Reference or order number field for the barcode
Depending on your use case, you can repurpose an existing field to carry additional information (for example, using the phone number field to pass a shipping method if it's not needed).
---
# Set up Post Haste
URL: https://support.starshipit.com/articles/4405262750479-set-up-post-haste
Canonical: https://support.starshipit.com/articles/4405262750479-set-up-post-haste
Markdown: https://support.starshipit.com/articles/4405262750479-set-up-post-haste.md
Updated: 2026-05-06
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Step-by-step guide to setting up Post Haste.
* Starshipit is now integrated with Post Haste in **New Zealand**.
* Post Haste (part of Freightways Group) are positioned in the wide and lucrative mid-market segment ensuring Freightways customers have an imperative market choice in terms of service levels and price point.
* Post Haste offers domestic express parcel delivery across New Zealand for anything as small as letter sized documents to large packages and boxes.
* Post Haste is available as a Domestic courier option when shipping from New Zealand.
## Before you begin
To integrate with Post Haste you'll need to have the following:
* Post Haste Account Number
* Client ID
* Client Secret
If you don't have these credentials, please contact your Post Haste account manager or [contact Post Haste via email or phone](https://www.posthaste.co.nz/contact_us.html).
## Set up Post Haste in Starshipit
To enable Post Haste as a courier in New Zealand:
1. In [Starshipit](https://app2.starshipit.com/), navigate to **Settings** > **Couriers** > **Add a new****courier**.
2. Select New Zealand in the **Shipping From** dropdown.
3. Click **Post Haste** from the list of couriers.
4. Tick **Enable Post Haste**.
5. Enter your Post Haste Account Number, Client ID and Client Secret**.**
6. Click **Save.
Once you've entered and saved these details click **Test to ensure it works** to confirm that your integration is correctly set up.
## Available product codes
Post Haste via Starshipit can be set up with two different product code types:
#### Overnight Delivery
Overnight is the standard service offering for Post Haste. Typically all same island deliveries are overnight. It can be used anywhere in New Zealand as long as NZ Couriers offers pickups and deliveries in that area.
#### Two Day Delivery
Two Day delivery is offered as an economy service for inter-island shipments. This means in Starshipit you will only see pricing for Two Day, if you have pricing loaded on your Post Haste account, and the shipment is inter-island (e.g. sending from Auckland to Christchurch)
## Add your product codes
Finally, add the product codes you'd like to use for Post Haste:
1. Click **Add a new product code**
2. Enter the **Code** and **Name** for the product code
3. If the product code should be your default, tick the **Default** checkbox
4. Click **Save**.
## Advanced settings
If required you can also update your Advanced Settings for Post Haste.
These advanced settings can be found in the **Advanced** tab:
* **Signature Required:** Select this option to default 'Signature Required' on all orders.
* **Saturday Delivery:** Select this option to default 'Saturday Delivery' on all orders.
* **Send Notifications:** To automatically send notifications for every order, enable this option. When dispatching orders, ensure this checkbox is selected. The default state of this option is determined by your settings preference.
* **Notification Type:** When send notifications is ticked, determine the type of notification that should be sent. Note that Freightways may incur additional charges for SMS notifications.
## FAQs
Can I set a specific product code based on whether the address is on the North/South island?
You can set up rules in Starshipit to assign a product code based on the postcode.
1. In Starshipit, navigate to **Settings** > **Rules** > Click **Add a new rule**.
2. Set the Condition(s) as **Destination Post Code - NZ**.
3. Set the operator as **Between**.
4. Input **0000** in the **From** field and **6999** in the **To** field. This represents the North Island.
5. Set the **Action** as **Set Courier & Product Code**.
6. Under Value, select **Post Haste**and a product code.
7. Click **Save** to create the rule.
8. Repeat steps 2-7 but replace step 4 with the one below to cover the South Island:
* Input **7000** in the **From** field and **9999** in the **To** field. This represents the South Island.
Why can't I see the OVERNIGHT text on the right-hand side of my labels?
If you want the overnight text to appear on your labels for same-island deliveries, ensure your label size is set to 100x174mm.
## Configure Post Haste settings
| Setting | What it does |
| --- | --- |
| Enable Post Haste | Makes Post Haste available for shipments. |
| Account number, Client ID, and Client secret | Authenticate your Post Haste account. |
| Use Staging URL | Uses the test endpoint. Keep this off for live shipments. |
| Product codes | Add the product codes enabled for your account and choose defaults. |
| Format for outbound labels and Format for return labels | Choose the paper size and layout for delivery and return labels. Select formats that work with your printer. |
| Signature Required | Applies signature as a default delivery option. |
| Saturday Delivery | Applies Saturday delivery as a default option when available. |
| Send Notifications and Notification Type | Sends Post Haste tracking updates to receivers and lets you choose how they receive them. |
| Mixed Packaging | Allows a shipment to use mixed packaging where supported. |
| Validate Receiver Address | Checks the receiver's delivery address before a shipment is created, so you can correct problems before a label is made. |
| Dangerous Goods | Add up to three dangerous-goods entries with the default flag, commodity number, shipping name, class, packing group, transport flags, flashpoint, and marine-pollutant flag. |
| Tools > Validate account | Tests the current credentials before shipping. |
| Tools > Cancel a shipment | Enter a tracking number to submit a cancellation. |
---
# Sending dangerous goods with Post Haste
URL: https://support.starshipit.com/articles/9117285858831-sending-dangerous-goods-with-post-haste
Canonical: https://support.starshipit.com/articles/9117285858831-sending-dangerous-goods-with-post-haste
Markdown: https://support.starshipit.com/articles/9117285858831-sending-dangerous-goods-with-post-haste.md
Updated: 2026-05-06
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Starshipit supports sending dangerous goods with Post Haste. You'll need. to add each dangerous good you wish to send with Post Haste to your Starshipit settings.
* Starshipit supports sending dangerous goods with Post Haste. You'll need to add each dangerous good you wish to send with Post Haste to your Starshipit settings.
* You’ll also need to follow Post Haste Dangerous Goods (DG) guidelines before transport.
* After adding Post Haste dangerous goods to Starshipit, you can set which orders contain dangerous goods using rules or set a default dangerous goods type.
## Getting set up with Post Haste
To ship Dangerous Goods with Post Haste, first, you'll need to integrate your Post Haste account to Starshipit. [Follow this guide to set up Post Haste.](/articles/couriers/post-haste/how-to-set-up-post-haste)
## Adding dangerous goods in Starshipit
To start, you’ll need to add dangerous goods to the Post Haste settings page in Starshipit.
1. Go to **Settings** > **Couriers**
2. Select **Post Haste**
3. Go to the **Dangerous Goods** tab
4. Click **Add new** to add the dangerous goods type.
5. Add DG details for each field
*Refer to the Material Safety Data Sheet of the product if needed*
6. Click **Save** to save your changes
It is recommended that you make sure all fields are filled out for hassle-free shipping. Post Haste also requires the item quantity, which you can set in the weight field of the item details.
## Sending orders containing dangerous goods
If you tick the Dangerous Goods box manually on the order details page, the default dangerous good selected on the settings page will be applied.
## Applying dangerous goods using rules
Once you’ve set up dangerous goods in Starshipit, you can apply them using rules. Any rules containing a dangerous good which has not been set up in your Starshipit settings will be ignored.
To assign dangerous goods using rules follow the below steps:
1. Navigate to **Settings** > **Rules**
2. Add a new rule with any condition. E.g: SKU equals 12345
3. Select the action **Set Dangerous Goods Type**
4. Select **Value** > **Post Haste**
5. In the field next to **Value**, enter the identification number (UN Number/Commodity ID number) of the dangerous good you’ve set up in Starshipit.
6. On import, all details will be copied from the dangerous goods you’ve set up to the order.
## Printing Dangerous Goods Declaration Form
The DG declaration form will be automatically generated as a PDF and downloaded to your computer at the same time as the label print, using the information from the Dangerous Goods setting when the shipment is flagged for containing dangerous goods.
---
# Set up Quantium Solutions
URL: https://support.starshipit.com/articles/360000313215-set-up-quantium-solutions
Canonical: https://support.starshipit.com/articles/360000313215-set-up-quantium-solutions
Markdown: https://support.starshipit.com/articles/360000313215-set-up-quantium-solutions.md
Updated: 2026-05-06
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Step-by-step guide to setting up Quantium Solutions.
* Quantium Solutions’ [integration with Starshipit](https://starshipit.com/partner/quantium-solutions-3pl) allows you to use all of [Starshipit's features](https://www.starshipit.com/features) including generation of packing slips and shipping labels, auto-correction of addresses, branded tracking and notifications and many more.
* This article outlines how to set up Quantium Solutions in Starshipit.
## Set up Quantium Solutions
### 1. Request your Quantium Solutions API information
To add Quantium Solutions to your Starshipit account, you first need to request your API information from [Quantium Solutions](mailto:kiat.chun@quantiumsolutions.com).
You will receive the following details:
| | |
| --- | --- |
| Account No | 999999 |
| Username | 999999 |
| Password | Password |
| API Cust ID | 108 |
| Encryption Key | NzQ3M234567yMDk0MzI3Y2Ri99999l0863836vyY2YzNzI1OTQxMw |
| API URL (Prod) | |
| API WSDL (Prod) | |
| Quantium Service | International Standard and International Premium |
### 2. Set up Quantium Solutions in Starshipit
1. In Starshipit, navigate to **Settings** > **Couriers** > **Add a new courier** > **Quantium Solutions**.
2. Enter your Username, Password, API Cust ID and Encryption Key.
3. Enter your product codes (refer to the product code list below).
4. Click **Save**.
### 3. Quantium Solutions product codes
These are the product codes and names - if you have a product code that is not on the list please contact our [support team](https://help.starshipit.com).
1. International Economy (QSIE01)
2. International Standard (QSIIR1)
3. International Premium (QSIEM1)
4. International ePAC (EZYPEPI)
:::note
Quantium Solutions doesn't pass rates into Starshipit, so they are not displayed in the New Order page. You can set up table rates for Quantium Solutions though, where you record the rates that the courier charges you, and these are then available via the Starshipit API.
:::
### Other relevant information for you
Learn more about automated packing machine rolled out by Quantium solutions [here](https://www.starshipit.com/blog-content/2019/12/11/future-of-ecommerce-delivery-with-starshipit-quantium-solutions?rq=quantium%20solutions).
## Configure Quantium Solutions settings
| Setting | What it does |
| --- | --- |
| Enable Quantium Solutions | Makes the courier available for shipment creation. |
| User name and Password | Authenticate the Quantium Solutions connection. |
| Customer ID | Identifies your Quantium Solutions customer account. |
| AES encryption key | Secures the customs data exchanged with Quantium Solutions. |
| Use Staging URL | Uses the test endpoint. Keep this off for live shipments. |
| Shipment Category | Sets the default customs category: Document, Gift, Merchandise, Sample, Other, or Not Set. |
| Other shipment description | Describes the goods when Shipment Category is Other. This is required for that category. |
| Ship by address code | Selects the configured sender address used by Quantium Solutions. |
| Product codes | Manage the services available on your Quantium Solutions account. |
---
# Set up Rendr
URL: https://support.starshipit.com/articles/4858109293583-set-up-rendr
Canonical: https://support.starshipit.com/articles/4858109293583-set-up-rendr
Markdown: https://support.starshipit.com/articles/4858109293583-set-up-rendr.md
Updated: 2026-03-06
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Step-by-step guide on how to set up Rendr.
* Rendr's integration with Starshipit allows you to use all of [Starshipit's features](https://www.starshipit.com/features) including generation of packing slips and shipping labels, auto-correction of addresses, branded tracking and notifications, and many more.
* Rendr delivery is currently supported domestically in Australia and New Zealand.
## What you need to get started
Before getting started with Rendr you will need a few things.
* [Create an account with Rendr](https://rendr.link/starshipit-rendr) if you haven't already.
Once this form has been completed, Rendr will reach out to you directly to provide the below credentials as well as an onboarding session.
* Rendr Client ID
* Rendr Client Secret
* Rendr Tenant ID
* Rendr Store ID
## Set up Rendr
To enable Rendr on your account:
1. In Starshipit, navigate to **Settings** > **Couriers** > **Add a new Courier** > **Rendr**.
2. Enter your Rendr details.
3. Select **Save**.
4. Click **Test to ensure it works**to validate that your credentials are working correctly.
5. Click **Configure All Product Codes**.This will enable all of the Rendr shipping options. You can remove any by clicking **Delete.** For information on the different codes, see below.
## Rendr Available Products
Rendr has three different products that you can use with Starshipit. They differ based on required transit time.
| Product Code | Product Name | Description |
| --- | --- | --- |
| FAST | Fast | Delivery in < 3 hours |
| FLEXIBLE | Flexible | Same Day delivery |
| STANDARD | Standard | Overnight/Interstate |
## Rendr Additional Features
**Special delivery requirements for Tobacco**
Starshipit allows you to flag with Rendr that your order includes tobacco. This means that on delivery Rendr will ensure that special delivery requirements for tobacco take place.You can set the tobacco flag as a default on all of your Rendr orders within Settings > Couriers > Rendr > Advanced, flag specific orders via the rules engine or on an order by order basis within the order details.
**Special delivery requirements for Alcohol**
Starshipit allows you to flag with Rendr that your order includes alcohol. This means that on delivery Rendr will ensure that special delivery requirements for alcohol take place. You can set the alcohol flag as a default on all of your Rendr orders within settings > couriers > Rendr > Advanced or flag on an order by order basis within the order details.
Rendr Contact: To get in touch with Rendr's friendly support team, you can reach them at [support@rendr.delivery](mailto:support@rendr.delivery) or call 1300 697 36
## Configure Rendr settings
| Setting | What it does |
| --- | --- |
| Enable Rendr | Makes Rendr available for new deliveries. |
| Client ID and Client Secret | Authenticate your Rendr account. |
| Tenant ID | Identifies the Rendr tenant for your account. |
| Store ID | Identifies the pickup location for the delivery. |
| Use the UAT environment | Sends requests to Rendr's test environment. Keep this off for live shipments. |
| Pickup Time Offset | Adds the specified number of minutes to the current time when a pickup is ordered. |
| Rendr services | Configure the Fast, Flexible, and Standard services. You can rename or remove services you do not offer. |
| Advanced delivery defaults | Set the **Alcohol (18+)**, **Tobacco (18+)**, and **Include line items in requests** options for new bookings. |
| Cancel Booking | Enter the order number (OurRef) or tracking reference to cancel a booking before the driver arrives at the pickup location. |
---
# Set up Royal Mail
URL: https://support.starshipit.com/articles/360001036915-set-up-royal-mail
Canonical: https://support.starshipit.com/articles/360001036915-set-up-royal-mail
Markdown: https://support.starshipit.com/articles/360001036915-set-up-royal-mail.md
Updated: 2026-03-06
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Step-by-step guide to setting up Royal Mail.
Set up Royal Mail in Starshipit to create domestic and international shipments. Send your account details to Starshipit first, then add the Royal Mail services you want to use.
## Before you begin
You need a [Royal Mail Online Business Account](https://www.royalmail.com/discounts-payment/credit-account/online-business-account), plus:
- Your **Royal Mail account number**. It starts with 3, 4, or 5; include a leading `0`.
- Your 10-digit **Posting Location**, which starts with 9.
- The email address used for your Royal Mail Online Business Account.
- Your return name and address, if they differ from your shipping address.
## Connect your Royal Mail account
Send the following to the [Starshipit support team](https://help.starshipit.com):
- Customer or company name
- Main shipping address
- Contact name, phone number, and email address
- Royal Mail account number and Posting Location
- Royal Mail Online Business Account email address
- Return name and address, if different from the shipping address
Starshipit will work with Royal Mail to complete the connection. Wait for confirmation before adding services.
## Add Royal Mail services
1. Go to **Settings > Couriers > Royal Mail**.
2. Open **Tools** and use the product code finder to find the services available for a destination.
3. Add the product codes you want to use and save your changes.
What are common Royal Mail product codes?
| Product code | Service |
| --- | --- |
| `BPL1` / `BPL2` | Royal Mail 1st Class / 2nd Class |
| `BPR1` / `BPR2` | Royal Mail Signed 1st Class / 2nd Class |
| `CRL1` / `CRL2` | Royal Mail 24 / 48 |
| `TPNN` / `TPNS` | Royal Mail Tracked 24 without / with signature |
| `TPSN` / `TPSS` | Royal Mail Tracked 48 without / with signature |
| `SD1`–`SD6` | Special Delivery Guaranteed services |
## Map service formats
Set a service format for each product code. The format affects Royal Mail charges, so choose the packaging type you use. Starshipit defaults to `P` for domestic shipments and `E` for international shipments.
1. Go to **Settings > Couriers > Royal Mail > Advanced**.
2. Select a product code and its service format.
3. Click **Add**.
4. Repeat for each product code you use, then click **Save**.
| Shipment type | Service formats |
| --- | --- |
| Domestic | `L` Letter, `F` Large Letter, `P` Parcel, `N` Not applicable |
| International | `P` Letter, `G` Large Letter, `E` Parcel, `N` Not applicable |
## Optional shipping settings
- **Duties & Taxes Paid:** Ask Royal Mail to enable the service first. You can then turn on **Sender Pays Duty** on an order, in the courier settings, or with a rule.
- **Notifications:** Go to **Settings > Couriers > Royal Mail > Notifications** to choose the default SMS or email notifications for tracked services.
- **Rates:** Royal Mail does not return rates to Starshipit. You can configure table rates for checkout and API quotes.
- **Tracking:** Use the [Royal Mail tracking page](https://www.royalmail.com/track-your-item#/) to track parcels.
## Prepare customs details for international or B2B shipments
For international or B2B shipments, make sure the order has the following information before you create a label:
| Information | Where it comes from |
| --- | --- |
| Shipper EORI number | [Shipper tax settings](/articles/orders-manifests-reports/orders/set-up-shipper-tax-numbers) or a shipping rule |
| Destination EORI number or UKIMS number | The order's **Tax Details** |
| Country of origin | The item's country of manufacture |
| HS code, SKU, and net weight | The item record |
### Mark a shipment as B2B
Apply the [`IsBusiness` tag](/articles/orders-manifests-reports/orders/tags) to mark an order as B2B. You can add the tag manually, apply it with a shipping rule, or pass it through from your connected platform or the Starshipit API.
Orders without the tag are sent as B2C.
## Configure Royal Mail settings
| Setting | What it does |
| --- | --- |
| Enable Royal Mail | Makes Royal Mail available for shipment creation. |
| Application ID | Identifies your Royal Mail application. |
| Posting Location | Sets the Royal Mail posting location. |
| Product codes | Add the services available on your Royal Mail account. Use **Tools > Get Products** or **Get Codes** to load account data. |
| Notifications | Choose no notification, SMS, email, or SMS and email as the default notification option. |
| Duties & Taxes Paid | Makes the sender responsible for duties and taxes when enabled. Leave off when the customer should pay. |
| Include Insurance Value | Adds the configured consequential-loss insurance value by default. |
| Product mapping | Map a product to the service format required for domestic or international shipments. |
| Tools > Get Products / Get Codes | Loads Royal Mail products and codes using the current account details. |
| Tools quote fields | Enter the sample street, suburb, postcode, city, state, country, length, height, width, and weight used when querying available Royal Mail products. |
---
# Cancel Royal Mail shipments
URL: https://support.starshipit.com/articles/360002048216-cancel-royal-mail-shipments
Canonical: https://support.starshipit.com/articles/360002048216-cancel-royal-mail-shipments
Markdown: https://support.starshipit.com/articles/360002048216-cancel-royal-mail-shipments.md
Updated: 2026-05-06
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Learn how to cancel Royal Mail shipments in Intelligent Shipper.
* Learn how to cancel Royal Mail shipments via Intelligent Shipper
* You should be cancelling all shipments which you do not send out to avoid being billed for them.
## Why do I need to cancel Royal Mail shipments?
Royal Mail requires all shipments to be manifested or cancelled whether they have been sent or not.
In Starshipit, you can print a label, then archive it or redo it and create a new label (redoing also archives shipments). The archived shipments must be cancelled if you wish to avoid unwanted charges.
:::warning
Any shipments which are not manifested in Starshipit or cancelled in Intelligent Shipper (see below) will beautomatically manifested at the end of every week on Sunday at 10:00 pm UK Time, resulting in unwanted charges from Royal Mail.
:::
## How do I cancel Royal Mail shipments?
Firstly, you will need access to the Intelligent Shipper portal. You should have a username and password for Intelligent Shipper from when our Customer Success team set you up. If not, please contact us [here](https://help.starshipit.com) for assistance.
1. Go to [Intelligent Shipper](https://starshipit.intelligentshipper.net/), and log in with your username and password.
2. On the left sidebar, click **Shipment Processing**.
3. Under Processed Shipments, click the arrows to refresh the shipments.
4. Click **View Shipments**.
5. Under View Shipments sort by **Shipment Date**.
6. Tick each shipment you need to cancel, then select **Cancel Shipments** in the top right corner.
7. Select a **Reason for Cancellation** (e.g. Wrong Service), then click **Yes**.
8. The shipments selected will be cancelled.
---
# Set up SEKO
URL: https://support.starshipit.com/articles/360000206496-set-up-seko
Canonical: https://support.starshipit.com/articles/360000206496-set-up-seko
Markdown: https://support.starshipit.com/articles/360000206496-set-up-seko.md
Updated: 2026-05-06
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Step-by-step guide to setting up SEKO.
* SEKO's [integration with Starshipit](https://www.starshipit.com/partner/seko) allows you to use all of [Starshipit's features](https://www.starshipit.com/features) including generation of packing slips and shipping labels, auto-correction of addresses, branded tracking and notifications and many more.
* This article outlines how to set up Seko as a courier into your Starshipit account.
### 1. Request your API key from Seko
Contact SEKO Logistics Support by submitting a ticket [here](https://seko.atlassian.net/servicedesk/customer/portal/31/group/95). Select OmniParcel, then include your account number. They will then provide you with your API key.
### 2. Add your API key in Starshipit
1. In Starshipit, navigate to **Settings** > **Couriers** > **Add a new courier** > **Seko**.
2. Tick **Enable Seko**.
3. Populate the Access Key field with the API key supplied by Seko.
4. Click **Save**.
:::note
There is no need to set up the SEKO product codes that you use. Starshipit will automatically call SEKO's systems and retrieve the available product codes when required. Default products can still be assigned via rules though.
:::
### Other relevant information for you
To learn more about APIs and their importance, [click here](https://www.starshipit.com/blog-content/tech-101-series-apis-explained?rq=API).
## Configure SEKO settings
| Setting | What it does |
| --- | --- |
| Enable SEKO | Turns the SEKO connection on. |
| Access Key | Authenticates requests to SEKO. |
| Signature Required | Requests a signature as a default delivery option. |
| Generate commercial invoice with label | Generates the commercial invoice together with the label. |
| Sender Pays Duty | Sets the sender as responsible for duties. |
| Send tracking emails (Seko notifications) | Requests SEKO tracking notifications. |
| Specify the service name on print | Prints the service name. If off, SEKO selects the cheapest service for the destination. |
| Label Format | Select PDF 100 x 150, PDF 100 x 200, or PDF A4. |
| Display SKU on labels | Prints SKUs on SEKO labels. |
| Product codes | SEKO retrieves available product codes from its systems when required. You do not need to enter them manually. |
---
# Sendle (services halted)
URL: https://support.starshipit.com/articles/115001240926-sendle-services-halted
Canonical: https://support.starshipit.com/articles/115001240926-sendle-services-halted
Markdown: https://support.starshipit.com/articles/115001240926-sendle-services-halted.md
Updated: 2026-05-06
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Understand the Sendle service halt and choose an alternative courier in Starshipit.
:::important
As of 11 January 2026, Sendle is no longer accepting new parcel bookings. If you're a Starshipit customer using Sendle, we recommend switching to another courier as soon as possible to keep your orders moving. Starshipit supports a wide range of carriers, including plug-and-play options like Australia Post MyPost Business and Aramex, which are fast to set up and require no contracts or minimum volumes. [Log in to update your carriers](https://app.starshipit.com). If you're new to Starshipit and looking for a replacement for Sendle, you can get set up today. We also offer free onboarding with a shipping expert, no matter your business size. [Start your free trial](https://cta-ap1.hubspot.com/web-interactives/public/v1/track/click?encryptedPayload=AVxigLLtByzMEIC0TZ82NtzRZl1PHOpqVDDMoQAILi671MmhWiUJS5pNYrzuA1G6TeTJya3XFJ7pMHOjolV8qg1bzhVPQ9b805RVXmAn4A8YLVTMiX3WNYxUKCMRHAyjs%2FRpaiAz217Ak5Oh49pXUJGV37jufQmJnakuWpGzM0rotw9kkVrU3ljk0jabuAAjM7%2Fhkf8%3D&portalId=19562611&webInteractiveId=608336899516&webInteractiveContentId=286610466261&containerType=BANNER&campaignId=b05fb8e0-96b7-4842-8c89-043bd7bf4a11&pageUrl=https%3A%2F%2Fstarshipit.com%2F%3Futm_term%3Dstarshipit%26utm_source%3Dgoogle%26utm_medium%3Dcpc%26utm_campaign%3DSearch%2B%257C%2BBrand%2B%257C%2BNZ%26hsa_cam%3D15285382278%26hsa_grp%3D135116541772%26hsa_mt%3Dp%26hsa_src%3Dg%26hsa_ad%3D701668902702%26hsa_acc%3D3261068119%26hsa_net%3Dadwords%26hsa_kw%3Dstarshipit%26hsa_tgt%3Dkwd-459042601081%26hsa_ver%3D3%26gad_source%3D1%26gad_campaignid%3D15285382278%26gbraid%3D0AAAAACsRqTyvBmsbmqXvoK23ck3FlCKhb%26gclid%3DCj0KCQiA7rDMBhCjARIsAGDBuEDC4H_KN7Y3F-OjJeXvoxxH4xqpUyfj366SBFAa-Z9dVzgrHe6iuGkaAju3EALw_wcB). [Read more about the Sendle update](https://www.sendle.com/).
:::
Sendle's [integration with Starshipit](https://www.starshipit.com/partner/sendle) supports domestic and international shipping from Australia, the USA, and Canada. Each shipping location requires a separate Sendle account with its own API keys, and a [separate child account](/articles/360001575375) in Starshipit.
## What you need to get started
Before getting started with Sendle you will need a few things:
* Set up an account with [Sendle](https://support.sendle.com/hc/en-au/articles/360000178172-Starshipit-integration)
* Your Sendle ID
* Your Sendle API key
If you are missing any of these credentials read [Sendle's Guide](https://developers.sendle.com/) on generating an API key.
## How to set up Sendle
To enable Sendle on your [Starshipit](https://app2.starshipit.com/) account:
1. Navigate to **Settings** > **Couriers** > **Add New Courier** > **Sendle.**
2. Select **Enable Sendle.**
3. Select **Enable New API**
We recommend using the new Sendle API as this supports all of Sendles products, shipping internationally when shipping from Australia as well as shipping domestically from US and Canada
4. Enter in your **Sendle ID** and **Sendle API Key.**
5. Click Save.
You will then need to set up your product codes. To add a product code:
1. Navigate to **Settings** > **Couriers** > **Add New Courier** > **Sendle.**
2. Click **Add a new product code.**
3. Enter in your product code (described below).
4. Click **Add.**
## Available products
For a full list of all Sendle product codes and their supported locations, please refer to Sendle's [guide](https://developers.sendle.com/docs/products).
| Code | Product Name | Description | International |
| --- | --- | --- | --- |
| STANDARD-DROPOFF | Sendle Standard Drop Off Service | Sendles standard service with drop off | This product is supported for orders in Australia, Canada and the USA. |
| EXPRESS-PICKUP | Sendle Express Pickup Service | Sendles express service | This product is only supported for Australia domestic orders |
| STANDARD-PICKUP | Sendle Standard Pickup | Sendles standard service with pickup | This product can be supported for both Australia international and domestic shipments. |
| STANDARD-PICKUP-UNLIMITED-SATCHEL | Sendle Pickup Unlimited Satchel***** | Sendle Unlimited Satchel service with pickup | This product is only supported for Australia domestic orders |
| STANDARD-DROPOFF-UNLIMITED-SATCHEL | Sendle Dropoff Unlimited Satchel***** | Sendle Unlimited Satchel service with dropoff | This product is only supported for Australia domestic orders |
:::important
The Unlimited Satchel service is only available when used in conjunction with Sendle's Compostable Satchel.
:::
## Additional features
Same day pickup: If using Sendle Express, you may wish to organise same-day pickup. By default, Sendle will pick up the parcel the next business day. To enable same-day pickup, tick Enable Same-Day Pickup for Sendle Express in your Sendle settings. If the order is shipped before 12 PM, Sendle will pick up the order on the same day.
Cancelling Orders: You can cancel an order in your Sendle Starshipit settings. Go to Settings > Couriers > Sendle > Tools > Enter the tracking number you would like to cancel.
SKU on label: You can enable SKU on labels for Sendle. This is mapped to the ref field on the label that is currently used for order number. You can enable this from Sendle advanced settings.
Pickups: Once you've printed a Sendle label, a job will be booked in the Sendle system. This automatically triggers a next-day pickup. Please note, that different drivers pick up domestic and international orders so if shipping both shipments you will need to keep the packages separate for pickup.
International: International is currently only supported for origin Australia shipments. Sendle doesn't yet service all of Australia for international. For a full list of suburbs, [see here.](https://docs.google.com/spreadsheets/d/16sWwLI7N0OjzREVWGkXbU3Z2TpHZmT4GYo3z2D8V2dQ/edit#gid=1846374610)
Size Category: If coming from Sendle dashboard, you will notice Starshipit doesn't have Sendle size categories. These are not required when booking through Starshipit. As long as you enter in the correct dimensions and weights, this will be selected automatically by Sendle when you click print.
Pickup Instructions: If you have specific instructions that you would like to be sent to the courier driver for picking up your packages. This can be configured from **Settings** > **Couriers** > **Sendle** > **Advanced** > **Pickup** **Instructions**. This will be sent to Sendle when you print your labels and they book the pickup on their end.
## Update orders
Sendle's integration with Starshipit allows you to make updates to orders in bulk. For orders that end up in the Printed tab, you can change the order status to transfer them to the Shipped tab.
#### How to update orders
1. In Starshipit, navigate to the **Printed** tab.
2. Select all the orders that should be updated.
3. Click on **Update status** in the top menu.
4. Under the dropdown menu, select **Shipped**.
5. Click **Update**.
## Cancel orders
You can now cancel Sendle labels that have been printed in Starshipit.
#### How to cancel an order
1. Navigate to **Settings** > **Couriers** > **Sendle Settings**.
2. Move to the **Tools** tab.
3. Under **Cancel a Shipment**, enter the tracking number of the order you would like to cancel.
4. Click **Cancel** to confirm.
Support Contact: integration-help@sendle.com
## Configure Sendle settings
Sendle service creation is currently halted. If the integration is available in your account, these are the settings shown on its setup page:
| Setting | What it does |
| --- | --- |
| Enable Sendle | Turns the Sendle connection on. |
| Sendle ID and Sendle API Key | Authenticate the connection. |
| Use Staging URL | Uses the test endpoint. |
| Product codes | Add the Sendle services you want to use. Sendle provides the supported code and location list. |
| Authority To Leave | Applies authority to leave as a default shipment option. |
| Include Insurance Value | Requests the configured insurance value by default. |
| Send SMS Notification | Requests an SMS tracking notification. |
| Display SKUs on label | Prints SKUs on the Sendle label. |
| Enable Same-Day Pickup for Sendle Express | Requests same-day pickup for orders placed before 12pm. |
| Pickup Instructions | Adds instructions for the Sendle pickup. |
| Contents Type | Sets the customs contents type, such as Documents, Gift, Merchandise, Returned Goods, or Sample. |
| Tools > Cancel a Shipment | Enter a tracking number to request cancellation. |
---
# Set up Sherpa
URL: https://support.starshipit.com/articles/4404581939343-set-up-sherpa
Canonical: https://support.starshipit.com/articles/4404581939343-set-up-sherpa
Markdown: https://support.starshipit.com/articles/4404581939343-set-up-sherpa.md
Updated: 2026-05-06
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Step-by-step guide to setting up Sherpa.
* Starshipit is now integrated with Sherpa in Australia & New Zealand.
* Sherpa offers On Demand delivery solutions including 2-hour, 4-hour and Same-day, 7 days a week till 9pm within Australia & New Zealand cities.
* Sherpa is available as a Domestic Courier option when shipping from Australia & New Zealand.
## Before you begin
To integrate with Sherpa you'll need to have your Sherpa Username and Password available. If you don't have these credentials, please contact your Sherpa account manager or email the [Sherpa team](mailto:info@sherpa.net.au).
## Enable Sherpa
To enable Sherpa as a Domestic courier in Australia or New Zealand:
1. In Starshipit, navigate to **Settings** > **Couriers** > click **Add a new****courier**.
2. Click **Sherpa** from the list of Domestic Couriers.
3. Tick **Enable Sherpa**.
4. Enter your Sherpa **Username** and **Password**.
5. Click **Save.**
Once you've entered and saved these details click **Test to ensure it works** to confirm that your integration is correctly set up.
## Select your vehicle type
Sherpa have 3 vehicle options to choose from:
* Car
* Motorbike/Scooter
* Van
By default this is set to Car.
You can select the vehicle type you'd like to use (your most common Vehicle Type) by going to **Vehicle Types** > Select the required option from the **Vehicle Types** list. Then click **Save**.
This can't be changed in an order so any changes to your selected Vehicle Type will need to be done here.
## Add your product codes
Finally, add the product codes you'd like to use for Sherpa by going to:
1. **Add product codes** section > Click **Add a new product code**.
2. Enter the **Code** and **Name** for the product code.
3. If the product code should be your default, tick the **Default** checkbox.
4. Click **Save**.
## Configure additional settings
You can configure additional settings in the Advanced Settings tab. Settings that can be configured are:
* Leave unattended (if no one available)
* Specified Recipient
* Alcohol (18+)
* Prescription Meds (18+)
* Tobacco (18+)
* Use generic description for all items
* Send Tracking SMS to recipient
## Cancel orders
You can now cancel Sherpa labels that have been printed in Starshipit.
#### How to cancel an order
1. Navigate to **Settings** > **Couriers** > **Sherpa** **Settings**.
2. Move to the **Tools** tab.
3. Under **Cancel a Shipment**, enter the tracking number of the order you would like to cancel.
4. Click **Cancel** to confirm.
## Configure Sherpa settings
| Setting | What it does |
| --- | --- |
| Enable Sherpa | Makes Sherpa available for delivery creation. |
| Username and Password | Authenticate your Sherpa account. |
| Use Staging URL | Uses the test endpoint. Keep this off for live shipments. |
| Vehicle type | Sets the default vehicle: Car, Motorbike/Scooter, or Van. Check Sherpa's size and weight limits for each vehicle. |
| Product codes | Add the delivery options available on your account. Same Day, 1 Hour, and Bulk Rate services require Sherpa approval. |
| Leave unattended, Specified Recipient, Alcohol, Prescription Meds, and Tobacco | Set the corresponding delivery requirements as defaults for new consignments. |
| Use generic description for all items | Uses the generic package description from **Settings > Defaults**. |
| Send Tracking SMS to recipient | Requests an SMS tracking notification. |
| Tools > Cancel a shipment | Enter a tracking number to submit a cancellation. |
---
# Set up StarTrack
URL: https://support.starshipit.com/articles/205615105-set-up-startrack
Canonical: https://support.starshipit.com/articles/205615105-set-up-startrack
Markdown: https://support.starshipit.com/articles/205615105-set-up-startrack.md
Updated: 2026-07-16
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Step-by-step guide to setting up StarTrack.
Connect your StarTrack account to Starshipit to print labels, book pickups, correct addresses, and send tracking notifications.
If you are interested in StarTrack Courier or AusPost OnDemand please refer to [this article](/articles/couriers/australia-post-ondemand-startrack-courier/set-up-australia-post-on-demand-startrack-courier).
## Before you begin
To set up the integration, you will need the following details:
* StarTrack Account number
* StarTrack API key
* StarTrack API secret
* If you are missing any of these credentials, follow [these steps](/articles/couriers/australia-post/generate-an-australia-post-startrack-api-key-and-secret) to source them.
* For pricing and label printing to work correctly, you will need to [set up your StarTrack unit types](/articles/couriers/startrack/about-startrack-unit-types).
## Setting up your StarTrack account in Starshipit
### 1. Add the StarTrack API in Starshipit
1. Go to **Settings** > **Carrier** > **Add a new courier** > **StarTrack**.
2. Tick **Enable StarTrack.**
3. Enter your Account Number, API Key, and Password (API Secret).
4. Click on **Lookup** to get your mailing location ID.
5. Click **Save**.
### 2. Add your product code
To complete the setup of your StarTrack integration, you need to enter your product codes. If you don't know your product codes, please contact your StarTrack Account Manager.
:::important
Only add product codes that are enabled on your StarTrack contract. StarTrack can accept a shipment using a product without contract pricing and apply a generic, non-contracted rate, so a successful label does not confirm that the product belongs to your contract.
:::
## Configure StarTrack settings
| Setting | What it does |
| --- | --- |
| Enable StarTrack | Turns the StarTrack connection on. |
| StarTrack Account No | Identifies your StarTrack account. |
| MLID | Identifies your mailing location. Use **Lookup MLID** after entering the account details. |
| API Key and API Password | Authenticate the StarTrack API connection. |
| Current Consignment Increment | Sets the next consignment number. It updates when a label is printed. |
| Integration | Choose the API mode. New customers should use the API; Legacy is available for existing accounts. |
| Use Staging URL | Uses the test endpoint. Keep this off for live shipments. |
| Authority To Leave | Applies authority to leave by default. |
| Safe Drop | Applies safe-drop handling by default where supported. |
| Display SKU in label | Prints the SKU on the StarTrack label. |
| Display Package Name on labels (instead of SKUs) | Prints the package name instead of the SKU. These two display options are mutually exclusive. |
| Set Movement Type to Transfer for All Consignments | Sends Transfer as the movement type for every consignment. |
| Automatically Manifest | Manifests orders automatically at the end of the day. |
| Call the API directly | Makes StarTrack API calls directly instead of asynchronously. |
| Product codes | Add the StarTrack services supplied by your account manager. |
| Dangerous Goods | Maintain the default, UN number, technical name, class, subsidiary risk, packing group, packaging, quantity, and net weight for each dangerous-goods entry. |
| Tools > Get Details from API | Loads account details using the current credentials. |
1. Click on **Add a new product code**.
2. Fill Product code with the specific code given by StarTrack.
3. Fill the Name field with whatever makes sense to you, e.g. "Premium" for the PRM service.
4. Click **Add**.
## Troubleshooting Error
### Upon clicking **Lookup**, the response is: "The request failed authentication" or similar
This means your account hasn't been activated properly. Please contact AusPost/StarTrack support at [customer_connectivity@auspost.com.au](mailto:customer_connectivity@auspost.com.au) with your API details or contact your StarTrack account manager directly.
:::note
There are now two special service movement codes available in the StarTrack API: Tailgate RET and RE2. While you can create shipping data and labels via Starshipit, the mechanism that alerts the special services team at StarTrack is not in place. Please contact your StarTrack representative to find out what process you need to follow to book special services pickups.
:::
---
# About StarTrack unit types
URL: https://support.starshipit.com/articles/209985086-about-startrack-unit-types-
Canonical: https://support.starshipit.com/articles/209985086-about-startrack-unit-types-
Markdown: https://support.starshipit.com/articles/209985086-about-startrack-unit-types-.md
Updated: 2026-05-06
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> With StarTrack you are required to specify a Unit Type for each package. Learn the different Unit Types available.
* With StarTrack you are required to specify a Unit Type for each package. This article outlines the different Unit Types available.
:::note
If you haven't already set up StarTrack,set it up now.
:::
## About StarTrack unit types
The Unit Type is specified in Starshipit by using Packaging or Boxes which is set up under **Settings** > **Package Setup**. For any box that you wish to use with StarTrack you must add a Unit Type, and this can be done by selecting the appropriate option from the drop down box. The Unit Type can be one of the following:
| | | |
| --- | --- | --- |
| Carton | Satchel | Pallet |
| Skid | Jiffy | Bag |
When you are shipping an order using the dialog, select from the list of packaging types or boxes, and the unit type of that box will be used for the package sent. If you batch print, it will use the unit type of the package pre-assigned to the shipment.
---
# StarTrack Dangerous Goods
URL: https://support.starshipit.com/articles/9547621561231-startrack-dangerous-goods
Canonical: https://support.starshipit.com/articles/9547621561231-startrack-dangerous-goods
Markdown: https://support.starshipit.com/articles/9547621561231-startrack-dangerous-goods.md
Updated: 2026-05-06
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Starshipit supports sending dangerous goods with StarTrack. Prior to. shipping, you'll need to add each dangerous good you wish to send with StarTrack to your settings.
* Starshipit supports sending dangerous goods with StarTrack.
* Prior to shipping, you'll need to add each dangerous good you wish to send with StarTrack to your settings.
* After adding StarTrack dangerous goods to Starshipit, you can set which orders contain dangerous goods using rules or set a default dangerous goods type.
* If you are using premium services like FPP or PRM, please read [this section](#h_01J8P70FCQBSSKW2JJPY168SC2).
* You can see the full list of approved StarTrack dangerous goods [here](https://auspost.com.au/content/dam/auspost_corp/media/documents/dangerous-goods-guide.pdf) or on the StarTrack website.
:::warning
Before sending dangerous goods, you must obtain approval from StarTrack first.
:::
## Adding dangerous goods in Starshipit
To start, you’ll need to add dangerous goods to your Starshipit account.
1. In Starshipit, navigate to **Settings** > **Couriers** > **StarTrack** > **Dangerous Goods**.
2. Fill out all compulsory fields except **Other than Subsidiary Risk** and **Package Group Designator**.
3. Click **Save**.
## Sending orders containing dangerous goods
If you tick the Dangerous Goods box manually on the order details page, the default dangerous good selected in the settings page will be applied.
#### Premium services
If you need to print orders containing dangerous goods on FPP or PRM (with StarTrack's approval), you will need to follow the steps below:
1. Before printing the order, ensure that the **Dangerous Goods** tickbox under the order options is **unchecked**.
2. Once you have printed the order, complete the IATA form [here](https://www.iata.org/contentassets/a9f496cd8c87466b98142fa6d4cdb209/shippers-declaration-column-format-fillable.pdf).
3. Hand the completed IATA form to the delivery driver on pick-up.
## Applying dangerous goods using rules
Once you’ve set up dangerous goods in Starshipit, you can apply them using rules. Any rules containing a dangerous good which has not been set up in your Starshipit settings will be ignored.
To assign dangerous goods using rules, follow the below steps:
1. Navigate to **Settings** > **Rules**.
2. Create a new rule with any condition. E.g. SKU equals 12345.
3. Set the action to **Set Dangerous Goods Type**.
4. Set the value to **StarTrack**.
5. In the field next to Value, enter the identification number (UN Number/Commodity ID number) of the dangerous good you’ve set up in Starshipit.
6. On import, all details will be copied from the dangerous goods you’ve set up to the order.
---
# Set up Team Global Express IPEC
URL: https://support.starshipit.com/articles/360000097295-set-up-team-global-express-ipec
Canonical: https://support.starshipit.com/articles/360000097295-set-up-team-global-express-ipec
Markdown: https://support.starshipit.com/articles/360000097295-set-up-team-global-express-ipec.md
Updated: 2026-05-06
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Step-by-step guide to setting up Team Global Express IPEC.
* Team Global Express' [integration with Starshipit](https://www.starshipit.com/partner/toll) allows you to use all of [Starshipit's features](https://www.starshipit.com/features) including generation of packing slips and shipping labels, auto-correction of addresses, branded tracking and notifications and many more.
* This article outlines how to set up Team Global Express IPEC as a courier service in Starshipit.
## Before you begin
You'll need your account number. This is given to you by your Team Global Express account manager.
## Setting up Team Global Express IPEC as a courier
1. Complete this [range request form](https://forms.office.com/r/4K32pFyw9H) for Team Global Express.
1. Enter your company name and business unit.
Starshipit currently supports **Priority**, **IPEC** or **Priority International.**
2. Enter the following values for the fields:
| | |
| --- | --- |
| Is this request a New Range or Replenishment Request | New Range Request |
| What Business Unit is the Replenishment Range for? | IPEC |
| Are you using MyTeamGE API? | Yes |
| Provide your Trading Partner or Platform Partner name | Starshipit |
:::note
Once the Team Global Express responds to your form request with your ranges. please forward their response to your Starshipit Onboarding Specialist or oursupport team.Starshipit will then set up your Team Global Express IPEC account and inform you once this is complete.
:::
## Insurance cover
Insurance cover is available for Team Global Express shipments up to $5,000. For over adding insurance cover over $5,000 please reach out to your Team Global Express account manager. Your Team Global Express version must be **Use MyTeamGE**.
You can enable and set the value of your insurance cover within an order. Alternatively, navigate to **Settings** > **Couriers** > **Team Global Express IPEC** > **Advanced** > **Use Declared Value if Cover/Warranty has not been set**. This setting will automatically use the declared value of an order for insurance cover if you do not set it within an order.
## Commodity codes
Team Global Express IPEC can require a commodity code for each package. Starshipit uses the commodity code on the package when one is available. If a package does not have its own commodity code, Starshipit uses the default commodity code saved in your Team Global Express IPEC settings.
The default commodity code is usually `Z`. Some services or freight profiles may require a different value, such as `G`. Confirm the correct value with your Team Global Express account manager before changing it.
To check the default commodity code:
1. Go to **Settings > Couriers**.
2. Open **Team Global Express IPEC**.
3. Open the **Advanced** settings.
4. Review the default commodity code.
5. Click **Save** if you make changes.
If you send an order with multiple packages that need different commodity codes, add the correct commodity code to each package before printing.
## Configure Team Global Express IPEC settings
| Setting | What it does |
| --- | --- |
| Enable Team Global Express IPEC | Turns the IPEC connection on. |
| Integration | Select the legacy or MyTeamGE API flow shown for your account. |
| MyTeamGE Account Number | Identifies the account used by the MyTeamGE API. |
| Source System Code (SYSID) and Shipment Prefix Code | Identify the MyTeamGE source and shipment-number range. |
| Use MyTeamGE API only for rates | Uses MyTeamGE to retrieve rates while the configured shipment flow handles labels. |
| Current Shipment Counter | Sets the next shipment number for the MyTeamGE flow. |
| Prefix code, Account Number, and Dispatch ID (SYSID) | Supply the legacy IPEC identifiers when the legacy flow is selected. |
| Online Username and Online Password | Authenticate the Team Global Express online services where required. |
| Commodity Code | Sets the default commodity code for IPEC shipments. |
| Intermodal | When enabled, enter the Intermodal account number and shipment range start/end. |
| Product codes | Add the services enabled on your Team Global Express account. |
| Use TheirRef instead of OurRef as reference number | Sends TheirRef as the shipment reference. |
| Use TheirRef as Item Description | Sends TheirRef as the item description. |
| Default pickup package type | Sets the package type used when booking pickups. |
| Tools > Remanifest an existing manifest | Enter a manifest number to submit a remanifest request. |
---
# Set up Team Global Express Priority
URL: https://support.starshipit.com/articles/115002222083-set-up-team-global-express-priority
Canonical: https://support.starshipit.com/articles/115002222083-set-up-team-global-express-priority
Markdown: https://support.starshipit.com/articles/115002222083-set-up-team-global-express-priority.md
Updated: 2026-08-20
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Step-by-step guide to setting up Team Global Express priority.
* Team Global Express Priority's [integration with Starshipit](https://www.starshipit.com/partner/toll) allows you to use all of [Starshipit's features](https://www.starshipit.com/features) including generation of packing slips and shipping labels, auto-correction of addresses, branded tracking and notifications and many more.
* This article outlines how to set up Team Global Express Priority as a courier service in Starshipit.
## Before you begin
You'll need your account number. This is given to you by your Team Global Express account manager.
## Setting up Team Global Express Priority as a courier
1. Complete this [range request form](https://forms.office.com/r/4K32pFyw9H) for Team Global Express.
1. Enter your company name and business unit.
Starshipit currently support **Priority**, **IPEC** or **Priority International**.
2. Enter the following values for the fields:
| | |
| --- | --- |
| Is this request a New Range or Replenishment Request | New Range Request |
| Select the TGE business unit the connote range is required for | Priority (Aus) |
| Are you using MyTeamGE API? | Yes |
| Provide your Trading Partner or Platform Partner name | Starshipit |
Once the Team Global Express responds to your request with your ranges, please forward these to your Starshipit Onboarding Specialist or our [support team](https://help.starshipit.com).
Starshipit will then set up your Team Global Express Priority account and let you know once this is complete.
:::note
If you do not receive an email after submitting the request you will need to re-submit, as the email address entered in the form was entered incorrectly.
:::
### Set up your product codes
1. Confirm with Team Global Express Priority which product codes to enter.
2. Go to **Settings**, then select **Couriers**.
3. Open your Team Global Express Priority Settings.
4. Click on **Add New Product Code**.
5. Enter the code and name.
6. Click **Add**.
7. Repeat steps 5-6 for each product code.
**Team Global Express B2C product code and product name**
Team Global Express Priority B2C:
* SH - B2C Priority Parcel ATL
* M7 - B2C Priority Parcel SR
Team Global Express Standard B2C:
* YG - B2C Standard Parcel ATL
* ZM - B2C Standard Parcel SR
**Team Global Express B2B product code and product name**
| | | |
| --- | --- | --- |
| **Code** | **Name** | **Product Code in Starshipit** |
| 02 | Parcels - Same Day | 10 |
| 02 | Parcels - Overnight | 11 |
| 02 | Parcels - OffPeak | 12 |
| 02 | Parcels Express After hrs and Sat | 13 |
| 02 | Parcels Express Sunday/Public Holiday | 14 |
| 20 | Auswide 1kg Satchel - Overnight | 20 |
| 21 | Auswide 3kg Satchel - Overnight | 21 |
| 22 | Auswide 5kg Satchel - Overnight | 22 |
| 26 | Auswide 3kg Label - Overnight | 26 |
| 60 | Optical 500gm Satc. - Overnight | 79 |
| 61 | Optical 3kg Satchel - Overnight | 61 |
## Insurance cover
Insurance cover is available for Team Global Express shipments up to $5,000. For over adding insurance cover over $5,000 please reach out to your Team Global Express account manager. Your Team Global Express version must be **Use MyTeamGE**.
You can enable and set the value of your insurance cover within an order. Alternatively, navigate to **Settings** > **Couriers** > **Team Global Express Priority**> **Advanced** > **Use Declared Value if Cover/Warranty has not been set**. This setting will automatically use the declared value of an order for insurance cover if you do not set it within an order.
## Commodity codes
Team Global Express may require a commodity code for some services. Starshipit uses the commodity code on the package when one is available. If a package does not have its own commodity code, Starshipit uses the default commodity code saved in your Team Global Express settings.
Confirm the correct commodity code with your Team Global Express account manager before changing the default value. If you send an order with multiple packages that need different commodity codes, add the correct commodity code to each package before printing.
## Booking pickups
Set your default pickup package type to ensure correct package type is automatically used when booking pickups, helping prevent booking errors.
### How to set your default pickup package type
1. Go to **Settings > Couriers**.
2. Select **TGE Priority** from your list of couriers.
3. Click on the **Advanced Settings** tab.
4. Under **Default pickup package type**, choose your preferred default from the dropdown list.
* Letter / Satchel
* Box / Carton
* Skid
* Pallet
* Jiffy Bag
* Tube
* Crate
* Length
5. Save your changes.
**Notes:**
* The default package type you select will be automatically applied when creating pickup bookings.
* If you book a pickup for certain satchel products (like Auswide Satchels), the system will override the global setting and automatically use **LESA (Letter/Satchel)**, even if your default is set to Box/Carton. This ensures the correct handling for satchel shipments.
## Configure Team Global Express Priority settings
| Setting | What it does |
| --- | --- |
| Enable Team Global Express Priority | Turns the Priority connection on. |
| Account Number and Dispatch ID | Identify your Priority account and dispatch configuration. |
| Online Username and Online Password | Authenticate the Team Global Express online services. |
| Product codes | Add the Team Global Express, Priority B2C, and Standard B2C product codes enabled for your account. |
| Signature Required and Authority To Leave | Set the default delivery options for new shipments. |
| Use Declared Value if Cover/Warranty has not been set | Uses declared value when cover or warranty is not supplied. |
| Disable Email Notifications | Stops optional email notifications. B2C products may still send contact details when required by Team Global Express. |
| Disable Receiver Phone/Email validation | Disables the receiver contact requirement only when Team Global Express has removed it for your account. |
| Enforce B2C parcel size and weight limits | Blocks supported B2C shipments above 22 kg, 135 cm combined dimensions, 105 cm per side, or 0.064 m³. |
| Display SKUs on labels and Use TheirRef instead of OurRef | Controls reference information printed or sent with the shipment. |
| Default pickup package type | Sets the package type used when booking pickups. Satchel services can override this setting. |
---
# Set up Team Global Express Priority International
URL: https://support.starshipit.com/articles/10764298911503-set-up-team-global-express-priority-international
Canonical: https://support.starshipit.com/articles/10764298911503-set-up-team-global-express-priority-international
Markdown: https://support.starshipit.com/articles/10764298911503-set-up-team-global-express-priority-international.md
Updated: 2026-05-06
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Step-by-step guide to setting up Team Global Express priority international.
Team Global Express’ [integration with Starshipit](https://www.starshipit.com/partner/toll) allows you to use all of [Starshipit’s features](https://www.starshipit.com/features) including generation of packing slips and shipping labels, auto-correction of addresses, branded tracking and notifications, live rates at checkout and many more.
This article outlines how to set up Team Global Express Priority International as a courier service in Starshipit.
## Before you begin
You’ll need your account number. This is provided by your Team Global Express account manager.
## Set up Team Global Express Priority International
1. Complete the [range request form](https://forms.office.com/pages/responsepage.aspx?id=eftnB29Wm0Sn68ZlwmG8LvlFKlZvkzBNtAKlhndAOCJUQkoyQTlXRjJESVRaWkw2UFJBQ1RQSjdPTS4u&route=shorturl) for Team Global Express.
2. Enter your company name and business unit. Starshipit currently supports **Priority**, **IPEC**, or **Priority International**.
3. Enter the following values in the form fields:
| Field | Value |
| --- | --- |
| Are you using MyTeamGE API? | Yes |
| Provide your Trading Partner name | Starshipit |
| Please advise the email address to return the range details to | The email address supplied by your Starshipit contact |
4. Once Team Global Express responds with your ranges, forward their email to your Starshipit Onboarding Specialist or our [support team](https://help.starshipit.com).
Starshipit will then set up your account and let you know when it’s ready.
:::note
If you don’t receive a confirmation email after submitting the form, re-submit — the email address entered in the form may have been incorrect.
:::
## Set up your product codes
1. Confirm with Team Global Express which services are enabled on your account.
2. In Starshipit, go to **Settings** > **Couriers** > **Team Global Express Priority International Settings**.
3. Click **Add a new product code**.
4. Enter the code and name.
5. Click **Add**.
6. Repeat steps 3–5 for each product code.
| Code | Product name |
| --- | --- |
| 01 | Global - Express Documents |
| 02 | Global - Express Parcels |
| 03 | Global - Express Airfreight |
| 06 | Global Mail - Small |
## Frequently asked questions
What happens if the same account details are used on another Starshipit account?
If the same Team Global Express Priority International account details are used on more than one Starshipit account, tracking numbers may overlap. To avoid this, ensure the shipment counter on the second account is set to **1,000,000** or higher before printing any labels. Contact the [Starshipit support team](https://help.starshipit.com) if you need help adjusting the shipment counter.
## Configure Team Global Express Priority International settings
| Setting | What it does |
| --- | --- |
| Enable Team Global Express Priority International | Turns the integration on. |
| MyTeamGE Account Number | Identifies your Priority International account. |
| Source System Code (SYSID) and Shipment Prefix Code | Supply the identifiers issued by Team Global Express for your shipment range. |
| Current Shipment Counter | Sets the next shipment number. Use a separate range when the same account is connected to multiple Starshipit accounts. |
| Online credentials | Enter the Team Global Express online username and password if your account requires them. |
| Product codes | Add the international Priority services enabled for your account. |
| Signature Required, Authority To Leave, and other advanced defaults | Configure the delivery options applied by default to new shipments. |
---
# Set up Team Global Express NZ
URL: https://support.starshipit.com/articles/6266994141199-set-up-team-global-express-nz
Canonical: https://support.starshipit.com/articles/6266994141199-set-up-team-global-express-nz
Markdown: https://support.starshipit.com/articles/6266994141199-set-up-team-global-express-nz.md
Updated: 2026-02-05
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Step-by-step guide to setting up Team Global Express NZ.
* Team Global Express NZ is a logistics company that delivers goods and services across New Zealand.
* Team Global Express NZ has two service types, Parcel and LCL. Starshipit supports both services.
### Before you begin
Before getting started with Team Global Express NZ you will need a few things:
* Request your Payer code from Team Global Express NZ (this can be found on your invoice). This will be unique to your Team Global Express NZ account.
* Reach out to our [support team](https://help.starshipit.com) with your Payer code. We will set up your Team Global Express NZ integration.
### Services and products
#### **Services**
Team Global Express has four service types:
* Door to door – Collected from and delivered to customers door.
* Door to Rail - Pickup from Customers door to Team Global Express Depot. Receivers need to organise their own collection.
* Rail to Door - Dropped off to the Team Global Express depot and delivered to the customer door.
* Rail to Rail – Dropped off to the Team Global Express Depot and collected from the Team Global Express depot. Not collected and neither delivered.
* Point to point - Freight travelling from customer site to customer site. Direct delivery. A truck will collect and deliver to the receiver on the go.
Starshipit users can set up one service type for their Team Global Express NZ shipments.
#### **Products**
Team Global Express NZ offers three service types: **Parcel**, **Satchel**, and **LCL**.
Starshipit now supports sending shipments using all three of these services:
* **Parcel** – for standard domestic deliveries
* **Satchel (A2 - A5)** – for smaller, pre-defined satchel packages.
* **LCL (Less than Container Load)** – for consolidated freight shipments.
## Configure Team Global Express NZ settings
| Setting | What it does |
| --- | --- |
| Enable Team Global Express NZ | Turns the courier on. |
| Payer code | Identifies the payer account linked to your Team Global Express NZ setup. |
| Service type | Select Door to Door, Door to Rail, Rail to Door, Rail to Rail, or Point to Point. |
| Product codes | Add the parcel, satchel, and LCL products enabled for your account. |
| Insurance type | Choose Owner's Risk, Limited Carrier Risk, or Declared Value. |
| Home delivery | Applies Home delivery as the default option. |
| Disable customer notifications | Stops email notifications for pickup, ready for delivery, and proof of delivery. |
| Use per-package cost estimates for multi-piece shipments | Uses the updated endpoint to price each package and combine the costs. |
| Package type | Sets the default package type for the LCL service. |
---
# Set up The Courier Guy
URL: https://support.starshipit.com/articles/90200000000108-set-up-the-courier-guy
Canonical: https://support.starshipit.com/articles/90200000000108-set-up-the-courier-guy
Markdown: https://support.starshipit.com/articles/90200000000108-set-up-the-courier-guy.md
Updated: 2026-05-25
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Connect The Courier Guy to create South African domestic labels and show live rates in Starshipit.
Connect The Courier Guy to Starshipit to create South African domestic labels and show live rates. This guide explains what you need from The Courier Guy or Shiplogic and how to add the courier to your Starshipit account.
## Before you begin
To connect The Courier Guy to Starshipit, you need:
* API key
* Origin host
* API base URL, if different from the default
* Default service code, if you want a fallback service
* Product or service codes supplied for your account
If you do not have these details, contact The Courier Guy or Shiplogic. You can also visit [The Courier Guy website](https://thecourierguy.co.za/) or refer to the [Shiplogic API documentation](https://www.shiplogic.com/api-docs).
## Set up The Courier Guy in Starshipit
1. In Starshipit, go to **Settings** > **Couriers** > **Add a new courier**.
2. Select **South Africa** as the shipping from country.
3. Select **The Courier Guy**.
4. Tick **Enable The Courier Guy**.
5. Enter your **API key**.
6. Enter your **Origin host** and **API base URL** if supplied.
7. Enter a **Default service code** if you want Starshipit to use one as a fallback.
8. If The Courier Guy gave you sandbox credentials, tick **Use sandbox**.
9. Click **Save**.
Your The Courier Guy integration is now connected. You can verify the setup by creating a test shipment.
## Add product codes
The Courier Guy uses service codes as Starshipit product codes. Add the service codes supplied for your account in the **Add Product Codes** area.
If product codes are configured, Starshipit only shows rates for those services.
## Limitations
* The Courier Guy supports domestic shipments within South Africa.
* International shipping and returns are not supported through this integration.
* The Courier Guy labels print as 100 x 150 mm labels.
* A separate manifest step is not required.
* Starshipit stores the tracking or waybill number returned by The Courier Guy, but tracking event updates are not currently supported.
## Troubleshooting
**No rates are showing?**
Check that:
* The order is a South African domestic shipment.
* Package details are complete.
* API key, origin host, and API base URL are correct.
* The selected sandbox or live setting matches your credentials.
* Product codes match services enabled on your account.
**Labels are not generating?**
Check that The Courier Guy is enabled, the selected service is available for the shipment, and your account has enough funds. Sandbox accounts may return insufficient-funds errors during shipment creation even when rates work.
## Configure The Courier Guy settings
| Setting | What it does |
| --- | --- |
| Enable The Courier Guy | Makes the courier available for rates and labels. |
| API Key | Authenticates the connection. |
| Use Sandbox | Sends requests to the sandbox environment. Use this with sandbox credentials. |
| API Base URL | Sets the API endpoint used by the courier. Keep the supplied value unless The Courier Guy gives you a different endpoint. |
| Origin Host | Identifies the Starshipit origin or account host used by the integration. |
| Default Service Code | Selects the service used when a shipment does not specify another product code. |
---
# Set up TNT
URL: https://support.starshipit.com/articles/115002006923-set-up-tnt
Canonical: https://support.starshipit.com/articles/115002006923-set-up-tnt
Markdown: https://support.starshipit.com/articles/115002006923-set-up-tnt.md
Updated: 2026-05-06
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Step-by-step guide to setting up TNT.
* TNT’s [integration with Starshipit](https://www.starshipit.com/partner/tnt) allows you to use all of [Starshipit's features](https://www.starshipit.com/features) including generation of packing slips and shipping labels, booking a courier pickup, auto-correction of addresses, branded tracking and notifications and many more.
* This article outlines how to set up your TNT account in Starshipit.
## Setting up your TNT account in Starshipit
### 1. Request your account activation
Starshipit can contact TNT on your behalf to set up a TNT account. To do this, please send the following information to our [support team](https://help.starshipit.com):
* Customer Account Number
* Customer Name
* Customer Address Line 1
* Customer Address Line 2
* Customer Suburb
* Customer State
* Customer Postcode
* Customer Contact Name
* Customer Phone Number
* Customer Email
* Services List
### 2. Request TNT access in Starshipit
Once your TNT account has been created, enter the account details in Starshipit.
1. Go to **Settings** > **Couriers** > **Add New Courier** > **TNT**.
2. Tick **Enable TNT**.
3. Enter your Account Number.
4. Click **Save**.
5. Click **Request TNT Access**.
6. Fill out the request form with your TNT account details.
7. Click **Request Access**.
This sends the request directly to the TNT team to authorise the integration.
### 3. Add your product codes
1. Click on **Add product code**.
2. Enter the product code and the product name.
3. Click **Save**.
4. Repeat these actions for all of the product codes.
### 3.1. TNT products codes and descriptions
| Product Code | Description |
| --- | --- |
| 76 | Road Express |
| 75 | Overnight Express |
| 73 | Overnight PAYU Satchel |
| 712 | 9:00 Express |
| EX10 | 10:00 Express |
| EX12 | 12:00 Express |
| 718 | Fashion Express |
| 701 | Time Critical - Next Flight |
| 717 | Premium Express |
| 717B | Sensitive Express |
### 4. Additional Configuration
**Extended Warranty**
With TNT you can opt-in for an extended warranty. For more information on Extended Warranty and classes, refer to [this guide](https://www.tnt.com/express/en_au/site/shipping-services/extended-warranty/domestic.html) from TNT.
To insure an order you can:
* On an order-by-order basis:
1. Open the order you would like to insure.
2. Tick the **Cover/Warranty Required** tickbox.
3. Enter a cover value on an order.
4. Click **Print**.
* Create a rule to automatically apply cover:
1. Go to **Settings** > **Rules** > **Create a new Rule.**
2. Select the condition (s) that apply.
3. Set the action to **Set Insurance Required** value to **True**.
**Residential Addresses**
Starshipit allows you to specify both sender and receiver addresses as residential.
**Sender Address**
* Go to Settings > Couriers > TNT > Advanced and enable the option Sender Address is Residential.
* When generating rates, Starshipit will inform TNT that the sender address is residential.
**Receiver Address**
To specify a receiver address as residential, use the DestinationIsResidentialAddress tag:
* Apply the tag **DestinationIsResidentialAddress** to your order, then refresh the rate or print the order. This will notify the system that the receiver address is residential.
For frequently used addresses, we recommend automating this with a rule:
* Example: If Destination Street Address contains "X", then apply the tag DestinationIsResidentialAddress.
This helps streamline the process and ensures consistency.
**TNT eReturns**
TNT eReturns lets TNT bring the return label when collecting the parcel, so the customer does not need to print a label from the returns portal.
Before using TNT eReturns:
* Confirm with TNT that eReturns is enabled for your account.
* Confirm with Starshipit support that your TNT returns setup is configured for eReturns.
* Test one return before sharing the workflow with customers.
For general returns setup, see [Returns with Starshipit FAQs](/articles/returns/returns/returns-with-starshipit-faqs).
## Configure TNT settings
| Setting | What it does |
| --- | --- |
| Enable TNT | Turns the TNT connection on. |
| TNT Account Number | Identifies your TNT account and is required before requesting access. |
| API Username, API User ID, and API Password | Authenticate TNT API requests. |
| Timeout on rate calls (s) | Sets how long Starshipit waits for a TNT rate response. |
| Use Staging URL | Uses the test endpoint. This does not change book-pickup requests, which continue to use TNT's production API. |
| Product codes | Add the TNT services enabled for your account. |
| Advanced defaults | Configure Signature Required, Authority To Leave, insurance value, SMS notification, sender residential status, SKU/reference display, eReturns, and Extended Warranty Class. |
---
# TNT: Dangerous Goods
URL: https://support.starshipit.com/articles/10309586112655-tnt-dangerous-goods
Canonical: https://support.starshipit.com/articles/10309586112655-tnt-dangerous-goods
Markdown: https://support.starshipit.com/articles/10309586112655-tnt-dangerous-goods.md
Updated: 2026-05-06
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Learn how to ship dangerous goods with TNT in Starshipit, including approvals and tagging.
* Starshipit supports sending dangerous goods with TNT.
* Prior to shipping, you'll need to add get approval from TNT to ship dangerous goods.
* You can set which orders contain dangerous goods using the tag TNT-DGS. This tag can be set on your orders manually, via rules or the API.
* You will need to attach a Dangerous Goods Declaration Form to your shipment. At this point, Starshipit does not support generating Dangerous Goods documentation for TNT. TNT has a [Dangerous Goods declaration](https://www.tnt.com/dam/tnt_express_media/tnt-local-pages/en_au/dangerous-goods/docs/road-rail-sea-shipping-doc.pdf) that customers can complete and attach to their shipment.
:::warning
Before sending dangerous goods, you must obtain approval from TNT.To learn more about shipping dangerous goods with TNT check out theirwebsite.
:::
### Adding the TNT-DGS tag in Starshipit
To ship dangerous goods with TNT all you need to do is tag your order with TNT-DGS. To do this, you’ll need to set up the tag in your Starshipit settings.
* Navigate to **Settings** > **Tags** > **Add new** > Enter **TNT-DGS** then click **Add**.
You can now apply this tag to orders containing Dangerous Goods. There are multiple ways to apply this tag to an order, you can do so manually in the orders grid, with the use of a rule or via the API.
### Assigning tags to an order
Before you get started, you will first need to enable the tags column on the orders grid.
In the Orders grid, click the plus icon in the tags column. From here you can add the TNT-DGS tag and then click apply.
You can bulk assign tags from the orders grid by selecting all the orders you want to update, selecting Add or Remove Tags from the action menu, and then entering (or removing) the tags you'd like to apply.
You can also apply tags within individual orders. When you open the order, in the bottom right you will see a section for tags where you can add or remove any tags.
You can assign tags to an order via rules. You can check out our guide [here](/articles/notifications-branded-tracking-rules-child-accounts/business-rules/rules-overview).
You can also assign tags to an order via the API. Head to our [Developer Center](/developers) to learn more.
### Additional Information
* Starshipit does not support generating Dangerous Goods documentation for TNT at this time.
* Starshipit does not support Dangerous Goods surcharges on TNT rates.
---
# Set up Uber
URL: https://support.starshipit.com/articles/4858092316687-set-up-uber
Canonical: https://support.starshipit.com/articles/4858092316687-set-up-uber
Markdown: https://support.starshipit.com/articles/4858092316687-set-up-uber.md
Updated: 2026-05-06
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Step-by-step guide to setting up Uber.
Connect Uber Direct to Starshipit for domestic deliveries in Australia and New Zealand. Uber provides live delivery prices; Starshipit creates a plain label for these shipments.
## Before you begin
You need an active Uber Direct account and your **Uber Client ID**. Ask your Starshipit Sales Representative, Customer Success Manager, or [support team](https://help.starshipit.com) for the client ID.
Complete billing and tax details in the Uber Direct Dashboard before creating live deliveries. If you use custom commercial terms, your Uber representative must configure the account first.
## Set up Uber
1. Go to **Settings > Couriers > Add a new courier > Uber**.
2. Tick **Enable Uber**.
3. Enter your Uber Client ID in the Customer ID field.
4. Select the country that your Uber account is associated with.
5. Click **Save**.
6. Click **Test to ensure it works** to validate that your credentials are correct.
### Choose the contract type
Some Uber accounts use standard pricing and some use custom pricing. If your Uber setup page includes a pricing or contract type field, select the option that matches the commercial terms on your Uber Direct account:
| Contract type | Use when |
| --- | --- |
| Standard pricing | Your Uber account uses Uber's standard parent pricing. |
| Custom pricing | Your Uber account has custom pricing agreed with Uber. |
If you are unsure which option applies, confirm with your Uber representative or Starshipit support before creating the Uber customer ID.
:::note
Use the same Uber Customer ID for each Starshipit child account when the locations share billing. Ask your Starshipit Onboarding Manager for a separate ID when locations need separate billing.
:::
## Configure delivery defaults
Uber does not use product codes. When you open an order, Starshipit shows Uber with the current delivery price.
- **Pickup scheduling:** Choose immediate, delayed, or a specific pickup time under **Settings > Couriers > Uber**. Delayed and scheduled pickups show a time window on the order before you print.
- **Delivery outcome:** Choose how Uber should handle a successful delivery (**Meet at door** or **Leave at door**) and an undeliverable order (**Return to sender**, **Leave at door**, or **Discard**).
- **Proof of delivery:** Turn on **Signature Required** or **Picture Required** when needed. You cannot use **Leave at door** when a signature is required.
- **Age-restricted goods:** Turn on **Age Restricted** and set the minimum recipient age. You can also set this per order.
- **Item-aware dispatch:** Add item weights and dimensions so Uber can choose an appropriate vehicle.
- **Tracking:** Uber's tracking link gives live driver updates. Starshipit can send it to customers at the **Printed** milestone.
## Live rates at checkout for Uber
Uber Direct deliveries are calculated based on a fixed fee plus a distance fee. In Starshipit, you can control your margins by bearing the costs or passing them on to your customers.
Here's how you control how you charge customers for an Uber Direct delivery:
1. Set up Uber Direct as a carrier in your Starshipit account.
2. In Starshipit, go to **Settings** \> **Checkout Rates**.
3. Click **Courier Configuration**.
4. Tick the **Enable advanced setting view** box.
5. Add Uber, then click either Contract Rates or Table Rates.
6. Within these settings, you can control what customers get charged by adding margins as an amount or percentage, for all orders or based on factors like where you're customers are located. [Learn more about live rates in this guide](/articles/rates-at-checkout/set-up-guides/about-live-rates-at-checkout-supported-couriers).
## Configure Uber settings
| Setting | What it does |
| --- | --- |
| Enable Uber | Turns Uber Direct on for shipment creation. |
| Customer ID | Identifies the Uber customer account connected to Starshipit. |
| External Store ID | Optional Uber store or location identifier supplied by Uber. |
| Country | Select Australia or New Zealand for the Uber account. |
| Serviceability | Enter the pickup postcode. Uber only returns a delivery option when the destination is within the refreshed serviceable postcode list. |
| Default undeliverable action | Choose Return to sender, Leave at door, or Discard. Leave at door cannot be used with signature or picture requirements. |
| Default deliverable action | Choose Meet at door or Leave at door for successful deliveries. |
| Signature Required, Picture Required, and Age Restricted | Set the default delivery requirements. Age Restricted also has a minimum age. |
| Hide Receiver Details | Prevents receiver email and phone details from printing on labels. |
| Pickup Scheduling Method | Choose immediately after printing, delayed after printing, or a specific date and time. |
| Require pickup barcode scan | Requires the pickup barcode to be scanned. |
| Delay minutes, Pickup date, and Pickup time | Define when the driver should arrive for the selected schedule method. |
| Refresh serviceable postcodes | Reloads the postcodes Uber serves from the configured pickup postcode. |
---
# Set up Uni Uni
URL: https://support.starshipit.com/articles/90200000000106-set-up-uni-uni
Canonical: https://support.starshipit.com/articles/90200000000106-set-up-uni-uni
Markdown: https://support.starshipit.com/articles/90200000000106-set-up-uni-uni.md
Updated: 2026-05-25
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Connect Uni Uni to create United States and Canada labels, show rates, and track shipments.
Connect Uni Uni to Starshipit to create labels, show rates, and track shipments in the United States and Canada. This guide explains what you need from Uni Uni and how to add the courier to your Starshipit account.
## Before you begin
To connect Uni Uni to Starshipit, you need:
* Customer number
* Client ID
* Client secret
* Pickup warehouse ID
* Tracking key, if Uni Uni supplied one
* Confirmation of whether you should use the United States or Canada environment
If you do not have these details, contact your Uni Uni account manager. You can also refer to the [Uni Uni documentation](https://docs.uniuni.com/) or the [Uni Uni business portal](https://biz.uniexpress.ca/login).
## Set up Uni Uni in Starshipit
1. In Starshipit, go to **Settings** > **Couriers** > **Add a new courier**.
2. Select **United States** or **Canada** as the shipping from country.
3. Select **Uni Uni**.
4. Tick **Enable Uni Uni**.
5. Enter your **Customer number**, **Client ID**, **Client secret**, and **Pickup warehouse ID**.
6. Enter your **Tracking key** if Uni Uni supplied one.
7. Use the sandbox environment only if Uni Uni gave you sandbox credentials.
8. Select the correct United States or Canada environment.
9. Click **Save**.
Your Uni Uni integration is now connected. You can verify the setup by creating a test shipment.
## Add product codes
Uni Uni product codes are optional. If you add product codes, use the codes supplied by Uni Uni. If you do not add a product code, Starshipit uses the standard Uni Uni service.
## Limitations
* Uni Uni supports shipments where the sender and receiver are in supported United States or Canada locations.
* Uni Uni supports single-package shipments only.
* Uni Uni labels print as 100 x 150 mm labels.
* Signature required is supported.
* A separate manifest step is not required.
## Troubleshooting
**No rates are showing?**
Check that:
* The shipment has one package only.
* The sender and receiver countries are supported United States or Canada locations.
* Customer number, client ID, and client secret are correct.
* Pickup warehouse ID is correct.
* Postcodes and package details are complete.
* The selected United States or Canada environment matches your account.
* The selected sandbox or production setting matches your credentials.
**Labels are not generating?**
Check that Uni Uni is enabled, the shipment has one package only, and all pickup and delivery address details are complete.
## Configure Uni Uni settings
| Setting | What it does |
| --- | --- |
| Enable Uni Uni | Makes Uni Uni available for rates, labels, and tracking. |
| Customer Number | Identifies your Uni Uni customer account. |
| Client ID and Client Secret | Authenticate the integration. |
| Use Sandbox Environment | Uses Uni Uni's test environment. Keep this off for live shipments. |
| Use US API Environment | Sends requests to the United States API instead of the default environment. |
| Pickup Warehouse ID | Identifies the warehouse used as the pickup location. |
| Tracking Key | Supplies the key Uni Uni uses for tracking updates. |
| Product codes | Select the Uni Uni service codes enabled for your account. |
---
# Set up UPS
URL: https://support.starshipit.com/articles/360001297215-set-up-ups
Canonical: https://support.starshipit.com/articles/360001297215-set-up-ups
Markdown: https://support.starshipit.com/articles/360001297215-set-up-ups.md
Updated: 2026-09-06
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Connect UPS to Starshipit with OAuth 2.0, add product codes, and confirm the integration works.
Connect UPS to Starshipit with OAuth 2.0 so you can create domestic and international UPS shipments from Starshipit.
## Before you begin
Make sure you have:
- A UPS username.
- A UPS password.
- Your UPS shipper number.
- Access to a UPS account that supports API integrations.
- The UPS product codes you want to use.
:::note
CampusShip UPS accounts are not supported for API integrations.
:::
## Connect UPS
1. Go to **Settings > Couriers > Add a new courier > UPS**.
2. Select **Enable UPS**.
3. Toggle to **Use UPS new**.
4. Enter your **UPS Shipper number**.
5. Click **Authorize**.
6. Sign in on the UPS login page with your UPS username and password.
7. Wait to be redirected back to the UPS settings page in Starshipit.
8. The OAuth connection is already saved. Click **Test to ensure it works**.
The **Save** button is only available after you change a setting, such as **Enable UPS** or your **UPS Shipper number**.
If the connection succeeds, Starshipit shows **Successful** on the UPS settings page. If you are not redirected back to Starshipit, see [UPS troubleshooting](/articles/90200000000132-ups-troubleshooting).
## Configure UPS services
After you connect UPS, add the UPS product codes you want to use.
1. Go to **Settings > Couriers > UPS**.
2. Add your UPS product codes.
3. Go to **Advanced** and enable any settings your workflow requires.
4. Click **Save**.
5. Create or open a test order and confirm the expected UPS services appear.
For product codes by country or territory, see [UPS product codes](/articles/90200000000129-ups-product-codes).
## Migrate from UPS Legacy
Use the UPS OAuth 2.0 integration for new UPS setups. If you are migrating from the legacy Access Key integration, you need to reselect your advanced settings after authorising the new integration.
For migration steps, see [Migrate UPS from Access Key to OAuth 2.0](/articles/90200000000128-migrate-ups-from-access-key-to-oauth-20).
## Troubleshooting
If authorisation fails, the redirect does not complete, or a UPS service does not appear, check [UPS troubleshooting](/articles/90200000000132-ups-troubleshooting).
## FAQ
Can I use a UPS DAP account via EasyPost for Starshipit?
No. Starshipit only supports direct UPS account integrations.
Can I submit additional shipping documentation for UPS orders?
Yes, but additional documents need to be printed outside Starshipit and placed in a sleeve on the outside of the package.
## Related articles
- [UPS product codes](/articles/90200000000129-ups-product-codes)
- [UPS returns](/articles/90200000000130-ups-returns)
- [UPS additional settings](/articles/90200000000131-ups-additional-settings)
- [UPS dangerous goods](/articles/8457265587343-ups-dangerous-goods)
- [Securing UPS credentials](/articles/360001435636-securing-ups-credentials)
## Configure UPS settings
| Setting | What it does |
| --- | --- |
| Enable UPS | Turns the UPS connection on. |
| Integration | Choose Legacy API or New API. New API setup uses UPS authorisation; legacy setup uses the credential fields shown for that mode. |
| Shipping number | Identifies your UPS shipper account. |
| User ID, Password, and Access license number | Authenticate the legacy UPS API. |
| Use staging URL | Uses the UPS test endpoint where supported. |
| Product codes and Return product codes | Add the outbound and return UPS services available on your account and mark defaults. |
| Advanced settings | Configure duties and taxes payer, negotiated rates, generic descriptions, archived-order cancellation, NAFTA/paperless documents, declared value, net-cost dates, transportation payment, producer information, and dangerous-goods defaults. |
| Dangerous goods | Add the required commodity, classification, packaging, weight, and regulatory values for each UPS dangerous-goods entry. |
| Tools > Cancel shipment | Enter a tracking number to request cancellation. |
---
# Migrate UPS from Access Key to OAuth 2.0
URL: https://support.starshipit.com/articles/90200000000128-migrate-ups-from-access-key-to-oauth-20
Canonical: https://support.starshipit.com/articles/90200000000128-migrate-ups-from-access-key-to-oauth-20
Markdown: https://support.starshipit.com/articles/90200000000128-migrate-ups-from-access-key-to-oauth-20.md
Updated: 2026-06-15
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Move UPS from the legacy Access Key authentication model to OAuth 2.0 in Starshipit.
Migrate your UPS integration from the legacy Access Key authentication model to OAuth 2.0 when you need to update how Starshipit connects to UPS.
## Before you begin
Make sure you have your UPS username, UPS password, and UPS shipper number. Note any advanced UPS settings you use, because you need to reselect them after authorising the new integration.
## Migrate to OAuth 2.0
1. Go to **Settings > Couriers > UPS**.
2. Under **UPS API Version**, click **Use UPS (New)**.
3. Click **Authorize**.
4. Sign in on the UPS login page with your UPS username and password.
5. Wait to be redirected back to the UPS settings page in Starshipit.
6. Click **Save**.
7. Click **Test to ensure it works**.
8. Re-enable any advanced settings your workflow requires.
If the connection succeeds, Starshipit shows **Successful** on the UPS settings page.
## Verify the migration
Create or open a test order and confirm the expected UPS services appear. If a service does not appear, check your UPS product codes and advanced settings.
## Related articles
- [How to set up UPS](/articles/360001297215-how-to-set-up-ups)
- [UPS product codes](/articles/90200000000129-ups-product-codes)
- [UPS troubleshooting](/articles/90200000000132-ups-troubleshooting)
---
# Configure UPS product codes
URL: https://support.starshipit.com/articles/90200000000129-configure-ups-product-codes
Canonical: https://support.starshipit.com/articles/90200000000129-configure-ups-product-codes
Markdown: https://support.starshipit.com/articles/90200000000129-configure-ups-product-codes.md
Updated: 2026-06-15
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Review UPS product codes by origin country or territory for Starshipit courier setup.
Add UPS product codes in Starshipit so the correct UPS services are available when you ship orders.
## Undefined countries or territories
Use these codes for all countries or territories other than the United States, Canada, European Union, Mexico, Poland, and Puerto Rico.
| Code | Service |
| --- | --- |
| 07 | UPS Express |
| 11 | UPS Standard |
| 08 | UPS Worldwide Expedited |
| 54 | UPS Worldwide Express Plus |
| 65 | UPS Worldwide Saver |
## All countries or territories
| Code | Service |
| --- | --- |
| 96 | UPS Worldwide Express Freight |
| M5 | UPS Priority Mail Innovations |
| M6 | UPS Economy Mail Innovations |
| 71 | UPS Worldwide Express Freight Mid-day |
## United States
| Code | Service |
| --- | --- |
| 11 | UPS Standard |
| 08 | UPS Worldwide Expedited |
| 07 | UPS Worldwide Express |
| 54 | UPS Worldwide Express Plus |
| 65 | UPS Worldwide Saver |
| 72 | UPS Worldwide Economy DDP |
| 17 | UPS Worldwide Economy DDU |
## United States domestic
| Code | Service |
| --- | --- |
| 02 | UPS 2nd Day Air |
| 59 | UPS 2nd Day Air A.M. |
| 12 | UPS 3 Day Select |
| M4 | UPS Expedited Mail Innovations |
| M2 | UPS First-Class Mail |
| 03 | UPS Ground |
| 01 | UPS Next Day Air |
| 14 | UPS Next Day Air Early |
| 13 | UPS Next Day Air Saver |
| M3 | UPS Priority Mail |
## Canada
| Code | Service |
| --- | --- |
| 02 | UPS Expedited |
| 13 | UPS Express Saver |
| 12 | UPS 3 Day Select |
| 70 | UPS Access Point Economy |
| 01 | UPS Express |
| 14 | UPS Express Early |
| 65 | UPS Express Saver |
| 11 | UPS Standard |
| 08 | UPS Worldwide Expedited |
| 07 | UPS Worldwide Express |
| 54 | UPS Worldwide Express Plus |
| 72 | UPS Worldwide Economy DDP |
| 17 | UPS Worldwide Economy DDU |
## European Union
| Code | Service |
| --- | --- |
| 70 | UPS Access Point Economy |
| 08 | UPS Expedited |
| 07 | UPS Express |
| 11 | UPS Standard |
| 54 | UPS Worldwide Express Plus |
| 65 | UPS Worldwide Saver |
| 74 | UPS Express 12:00 |
| 72 | UPS Economy DDP |
| 17 | UPS Economy DDU |
## Mexico
| Code | Service |
| --- | --- |
| 70 | UPS Access Point Economy |
| 08 | UPS Expedited |
| 07 | UPS Express |
| 54 | UPS Express Plus |
| 11 | UPS Standard |
| 65 | UPS Worldwide Saver |
## Poland
| Code | Service |
| --- | --- |
| 70 | UPS Access Point Economy |
| 08 | UPS Expedited |
| 07 | UPS Express |
| 54 | UPS Express Plus |
| 65 | UPS Express Saver |
| 11 | UPS Standard |
| 83 | UPS Today Dedicated Courier |
| 85 | UPS Today Express |
| 86 | UPS Today Express Saver |
| 82 | UPS Today Standard |
| 72 | UPS Economy DDP |
| 17 | UPS Economy DDU |
## Puerto Rico
| Code | Service |
| --- | --- |
| 02 | UPS 2nd Day Air |
| 03 | UPS Ground |
| 01 | UPS Next Day Air |
| 14 | UPS Next Day Air Early |
| 08 | UPS Worldwide Expedited |
| 07 | UPS Worldwide Express |
| 54 | UPS Worldwide Express Plus |
| 65 | UPS Worldwide Saver |
## Verify product codes
Create or open a test order and confirm the expected UPS services appear. If a service is missing, check that the product code is saved and supported for the shipment origin and destination.
## Related articles
- [How to set up UPS](/articles/360001297215-how-to-set-up-ups)
- [UPS troubleshooting](/articles/90200000000132-ups-troubleshooting)
---
# Set up UPS returns
URL: https://support.starshipit.com/articles/90200000000130-set-up-ups-returns
Canonical: https://support.starshipit.com/articles/90200000000130-set-up-ups-returns
Markdown: https://support.starshipit.com/articles/90200000000130-set-up-ups-returns.md
Updated: 2026-06-15
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Configure UPS return product codes and create UPS return shipments in Starshipit.
Use UPS returns in Starshipit when UPS has enabled returns on your UPS account.
## Before you begin
Ask UPS to enable returns on your account. Starshipit supports rates for UPS Print Return Label Service.
## Set up UPS returns
1. Go to **Settings > Couriers > UPS**.
2. Add your **UPS Return Product codes**.
3. Set a default return service.
4. Click **Save**.
You can generate a UPS return from an existing shipped order in Starshipit or create a manual return.
## UPS return services
| Code | Service |
| --- | --- |
| 2 | UPS Print and Mail (PNM) |
| 3 | UPS Return Service 1-Attempt (RS1) |
| 5 | UPS Return Service 3-Attempt (RS3) |
| 8 | UPS Electronic Return Label (ERL) |
| 9 | UPS Print Return Label (PRL) |
| 10 | UPS Exchange Print Return Label |
| 11 | UPS Pack & Collect Service 1-Attempt Box 1 |
| 12 | UPS Pack & Collect Service 1-Attempt Box 2 |
| 13 | UPS Pack & Collect Service 1-Attempt Box 3 |
| 14 | UPS Pack & Collect Service 1-Attempt Box 4 |
| 15 | UPS Pack & Collect Service 1-Attempt Box 5 |
| 16 | UPS Pack & Collect Service 3-Attempt Box 1 |
| 17 | UPS Pack & Collect Service 3-Attempt Box 2 |
| 18 | UPS Pack & Collect Service 3-Attempt Box 3 |
| 19 | UPS Pack & Collect Service 3-Attempt Box 4 |
| 20 | UPS Pack & Collect Service 3-Attempt Box 5 |
## Verify returns
Create a test return shipment and confirm the expected UPS return service appears before using returns for live orders.
## Related articles
- [How to set up UPS](/articles/360001297215-how-to-set-up-ups)
- [UPS product codes](/articles/90200000000129-ups-product-codes)
---
# Troubleshoot UPS
URL: https://support.starshipit.com/articles/90200000000132-troubleshoot-ups
Canonical: https://support.starshipit.com/articles/90200000000132-troubleshoot-ups
Markdown: https://support.starshipit.com/articles/90200000000132-troubleshoot-ups.md
Updated: 2026-06-15
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Fix common UPS authorisation and account redirect issues in Starshipit.
Use these checks when UPS authorisation does not redirect back to Starshipit or the integration cannot be tested successfully.
## UPS authorisation does not redirect back to Starshipit
If UPS does not redirect you back to Starshipit, you may be using a CampusShip UPS account. CampusShip accounts are not supported for API integrations.
To resolve this, create a new UPS user ID and add your UPS account to that user ID.
1. Sign up for a new UPS ID on the [UPS signup page](https://www.ups.com/doapp/signup?loc=en_US).
2. Sign in to UPS with the new user ID.
3. Click your profile icon.
4. Click **Accounts and Payment**.
5. Under **Add a Payment Method**, select **Add Existing Account**.
6. Click **Add**.
7. Choose a validation method. You can use **Invoice Data Verification** or **PIN Verification**.
8. If you choose PIN verification, select **I need to request a PIN** and enter the email address for the account owner.
9. Retrieve the PIN from the account owner and enter it.
PIN information is valid for 30 minutes. After completion, UPS adds the account to the new user ID and emails the account owner.
## Verify the fix
Return to **Settings > Couriers > UPS**, click **Authorize**, and sign in with the UPS user ID linked to your UPS account. After redirecting back to Starshipit, click **Save**, then click **Test to ensure it works**.
## Related articles
- [How to set up UPS](/articles/360001297215-how-to-set-up-ups)
- [Migrate UPS from Access Key to OAuth 2.0](/articles/90200000000128-migrate-ups-from-access-key-to-oauth-20)
- [Securing UPS credentials](/articles/360001435636-securing-ups-credentials)
---
# Configure additional UPS settings
URL: https://support.starshipit.com/articles/90200000000131-configure-additional-ups-settings
Canonical: https://support.starshipit.com/articles/90200000000131-configure-additional-ups-settings
Markdown: https://support.starshipit.com/articles/90200000000131-configure-additional-ups-settings.md
Updated: 2026-07-23
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Configure optional UPS settings for negotiated rates, international shipments, pickups, validation, and handling.
Configure optional UPS settings when your shipping workflow needs negotiated rates, international invoice settings, pickups, address validation, or special handling.
## Negotiated rates
Starshipit uses UPS retail rates by default. If your UPS account has negotiated rates, go to **Settings > Couriers > UPS > Advanced** and select **Use Negotiated Rates**.
## International settings
For international UPS shipments, configure your incoterms, export type, and tax identification number in **Settings > Couriers > UPS > Advanced**.
You can also charge duties and taxes to a third-party account, such as a Zonos account. Enter the third-party duty and tax billing details in **Settings > Couriers > UPS > Advanced**, then click **Save**.
## Classify eligible EU shipments as business-to-business
For UPS shipments travelling to the European Union from outside the EU, add the `IsBusiness` tag to classify an order as business-to-business. Without this tag, Starshipit classifies the order as business-to-consumer.
1. Open the order and add the tag `IsBusiness` in the **Tags** section.
2. Print the label as usual.
You can also add the tag automatically with an order rule. For help adding or automating tags, see [Add and use order tags](/articles/4929125101327-add-and-use-order-tags).
:::note
An eligible order with a selected IOSS tax number is classified as business-to-consumer. Add `IsBusiness` only to orders that should be treated as business-to-business.
:::
## NAFTA Certificate of Origin
You can configure settings for the **NAFTA Certificate of Origin** for shipments between Canada, Mexico, the United States, and Puerto Rico.
The NAFTA Certificate of Origin is attached to an invoice if the shipment value is greater than:
- $1,000 USD when shipping to Mexico from Canada or the United States.
- $2,500 CAD when shipping to Canada from Mexico or the United States.
- $2,500 USD when shipping to the United States from Canada or Mexico.
## Paperless invoice
You can enable UPS paperless invoice for commercial invoices and NAFTA Certificate of Origin documents in advanced settings.
:::note
UPS must also enable paperless trade on your UPS account. If paperless trade is working, `EDI` appears at the bottom right of paperless trade labels. Otherwise, `INV` appears.
:::
## Declared value
UPS may charge additional fees when you specify a declared value for international shipments. To disable declared value for international shipments, go to **Settings > Couriers > UPS > Advanced** and tick **Exclude Declared Value for International Shipments**.
## Pickups and cancellations
Starshipit supports booking UPS pickups. For pickup steps, see [Book a courier pickup](/articles/360000133996-book-a-courier-pickup).
To cancel a UPS shipment, go to **Settings > Couriers > UPS > Tools**, enter the shipment tracking number, and submit the cancellation.
## Adult signature and special handling
To require age verification, tick **Adult Signature** on the order.
To flag large packages or packages that need additional handling, use the large package and additional handling tickboxes in the order details. This helps return rates that include the relevant surcharges.
## Enhanced address validation for US shipments
Enhanced address validation checks US receiver addresses with UPS before label generation. If the address is valid, Starshipit generates the label. If the address is invalid, Starshipit returns an error so you can update the address.
1. Go to **Settings > Courier > UPS (New)**.
2. Open the **Advanced** tab.
3. Tick **Enable address validation for United States shipments**.
4. Click **Save**.
:::note
Enhanced address validation is not supported in the UPS Legacy integration.
:::
## Configure UPS advanced settings
The **Advanced** tab includes these settings. Some fields only apply to international shipments or to the NAFTA Certificate of Origin.
| Setting | What it does |
| --- | --- |
| Duties & taxes paid | Sets duties and taxes as paid by the sender by default. Leave off when the receiver pays. |
| Use negotiated rates | Uses the negotiated UPS rates configured for your account. |
| Use generic description for items | Uses the generic description from **Settings > Options** on the commercial invoice. |
| Automatically cancel archived orders | Cancels the UPS shipment when its order is archived. |
| Attempt creation of NAFTA CO | Attempts to create a NAFTA Certificate of Origin when applicable. |
| Use paperless invoice | Uses paperless commercial-invoice and NAFTA documents where UPS supports them. |
| Joint production | Uses `JNT` as the origin code on the NAFTA form. |
| Use net cost method | Calculates the regional value content using the net-cost method. |
| Exclude declared value for international shipments | Omits declared value from international UPS shipments. |
| Net cost date range | Sets the date range used for the NAFTA regional-value calculation. |
| Default export type and Other description | Sets the customs export type and supplies a description when Other is selected. |
| Tax identification number | Supplies the business tax number used for US imports or exports. |
| Duty and tax number, account country code, and postal code | Identifies the third-party account used for duty and tax billing. |
| Duty and tax payment type | Chooses sender or third-party duty and tax billing. |
| Transportation billing account number, country code, and postal code | Identifies the third-party account used for transportation charges. |
| Transportation payment type | Chooses sender or third-party transportation billing. |
| NAFTA producer details | Describes the producers of goods for a NAFTA Certificate of Origin. |
| NAFTA producer information | Records how the shipper knows the goods qualify as originating goods. |
| NAFTA preference criteria | Sets the preference criteria for products on a NAFTA Certificate of Origin. |
| NAFTA CO blanket period | Sets the importation date range covered by a NAFTA Certificate of Origin. |
| Enable address validation for United States shipments | Checks US delivery addresses before a label is created, so you can correct problems before booking. |
The **Dangerous goods** tab also includes **Default**, **Class / Division Number**, **HazMat Commodity ID Number**, **Transportation Mode**, **Regulation Set**, **Package Type**, **Proper Shipping Name**, **Technical Name**, and **Regulation Type** for each entry.
## Related articles
- [How to set up UPS](/articles/360001297215-how-to-set-up-ups)
- [UPS dangerous goods](/articles/8457265587343-ups-dangerous-goods)
- [UPS troubleshooting](/articles/90200000000132-ups-troubleshooting)
---
# Configure UPS dangerous goods
URL: https://support.starshipit.com/articles/8457265587343-configure-ups-dangerous-goods
Canonical: https://support.starshipit.com/articles/8457265587343-configure-ups-dangerous-goods
Markdown: https://support.starshipit.com/articles/8457265587343-configure-ups-dangerous-goods.md
Updated: 2026-05-06
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Starshipit supports sending dangerous goods with UPS. You'll need to. add each dangerous good you wish to send with UPS to your Starshipit settings.
* Starshipit supports sending dangerous goods with UPS. You'll need to add each dangerous good you wish to send with UPS to your Starshipit settings.
* You’ll also need approval from UPS before sending dangerous goods – Contact your UPS account manager.
* After adding UPS dangerous goods to Starshipit, you can set which orders contain dangerous goods using rules or set a default dangerous goods type.
* You can see the full list of approved UPS dangerous goods [here](https://www.aircargo.ups.com/Media/PDfDocuments/UPSAirCargoApprovedDangerousGoods.pdf) or on the UPS website.
### Getting set up with UPS
To ship Dangerous Goods with UPS, first you'll need to [integrate your UPS account](/articles/couriers/ups/how-to-set-up-ups) to Starshipit.
### Adding dangerous goods in Starshipit
To start, you’ll need to add dangerous goods in the UPS settings page in Starshipit.
* Navigate to **Settings** > **Couriers** > **UPS Settings** > **Dangerous Goods**.
All fields are compulsory except HazMat Technical name. UPS also requires the item quantity, which you can set in the weight field of the item details.
### Sending orders containing dangerous goods
If you tick the Dangerous Goods box manually in the order details page, the default dangerous good selected in the settings page will be applied.
### Applying dangerous goods using rules
Once you’ve set up dangerous goods in Starshipit, you can apply them using rules. Any rules containing a dangerous good which has not been set up in your Starshipit settings will be ignored.
To assign dangerous goods using rules follow the below steps:
1. Navigate to **Settings** > **Rules**.
2. Create a new rule with any condition. E.g: SKU equals 12345.
3. Select the action **Set Dangerous Goods Type**.
4. Select **Value** > **UPS**.
5. In the field next to Value, enter the **identification number (UN Number/Commodity ID number)** of the dangerous good you’ve set up in Starshipit.
6. On import, all details will be copied from the dangerous good you’ve set up to the order.
---
# Set up Urgent Couriers
URL: https://support.starshipit.com/articles/11406715111695-set-up-urgent-couriers
Canonical: https://support.starshipit.com/articles/11406715111695-set-up-urgent-couriers
Markdown: https://support.starshipit.com/articles/11406715111695-set-up-urgent-couriers.md
Updated: 2026-05-06
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Step-by-step guide to setting up Urgent Couriers.
We’re excited to announce that Starshipit is now integrated with Urgent Couriers!
* Urgent Couriers is one of New Zealand’s largest specialized on-demand courier services, recognized for fast, premium delivery both domestically and internationally.
* They offer a range of point-to-point services in Auckland, from 15-minute express deliveries to same-day economy runs.
* As New Zealand’s first carbon-neutral courier service, Urgent Couriers is a sustainability leader, setting the benchmark for eco-friendly transport across the country.
## Before you begin
To connect Urgent Couriers with your Starshipit account, you’ll need your:
* Urgent Couriers Username
* Urgent Couriers Password
If you don’t have these credentials, please contact your Urgent Couriers account manager.
## Set up Urgent Couriers
1. In Starshipit, go to **Settings** > **Couriers** > Add a new courier.
2. Select **New Zealand** from the **Shipping From** dropdown menu.
3. Choose **Urgent Couriers** under the **New Zealand Domestic** section.
4. Tick **Enable Urgent Couriers**.
5. Enter your Urgent Couriers Username and Password.
6. Select the **Label Size** you want for your shipments.
7. Click **Save** to confirm your integration details.
## Adding product codes
Finally, add the product codes you’d like to use for Urgent Couriers:
1. Navigate to the **Product Codes** section.
2. Click **Add New Product Code**.
3. Enter the **Code** (SpeedID) and **Product Name**. For example:
* Code: 20 | Product Name: 45 Minutes
* Code: 75 | Product Name: 75 Minutes
* Code: 24 | Product Name: 90 Minutes
* Code: 1 | Product Name: 1 Hour
* Code: 25 | Product Name: 2 Hours
* Code: 4 | Product Name: 3 Hours
4. Click **Add** to save the product code.
:::note
Urgent Couriers refer to the product code as Speed ID.If you'd like a product code set as your default, make sure to tick the Defaultcheckbox before saving.
:::
## Additional information
Learn more about Urgent Couriers’ shipping services [here](https://fast.urgent.co.nz/services/).
## FAQs
**Does Urgent Couriers support multi-package shipments?**
Yes, Urgent Couriers supports multi-package shipments/orders.
**Are shipments created in Starshipit scheduled for pickup by Urgent Couriers?**
Yes, all shipments created through Starshipit are considered pickup jobs.
**Urgent Couriers offer Van, Bike, and Truck deliveries. How do I specify the vehicle type for my shipment?**
Currently, this option isn’t supported through Starshipit. By default, the system will book the shipment as a car job based on the package details.
**Can I book an overnight service?**
Yes, you can book an overnight service if it’s enabled for your account.
**I use the Urgent Couriers app at checkout. Can I generate labels for jobs created through their app?**
No, at this time, you can only generate labels for jobs created through Starshipit. If you attempt to create a label for a job initiated via the Urgent Couriers app, it will be treated as a new job. We recommend excluding these orders from import into Starshipit to avoid duplicates.
## Configure Urgent Couriers settings
| Setting | What it does |
| --- | --- |
| Enable Urgent Couriers | Makes Urgent Couriers available for shipment creation. |
| Username and Password | Authenticate your Urgent Couriers account. |
| Label size | Selects A4 or 100x175mm labels. |
| Use predefined job Number from order tag for label creation | Uses the job number in the order tag when creating a label. Use the format `Job Numbers: [jobNumber]`. |
| Product codes | Add the Speed IDs and names supplied by Urgent Couriers, then choose a default service. |
| Tools > Cancel a Shipment | Enter a tracking number to request cancellation of an existing shipment. |
---
# Set up USPS
URL: https://support.starshipit.com/articles/5767391395855-set-up-usps
Canonical: https://support.starshipit.com/articles/5767391395855-set-up-usps
Markdown: https://support.starshipit.com/articles/5767391395855-set-up-usps.md
Updated: 2026-02-05
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Step-by-step guide to setting up USPS.
* United States Postal Service (USPS) delivers parcels throughout the United States of America.
* Starshipit's integration with USPS allows you to ship both domestically and internationally ex: the United States of America.
* USPS integration with Starshipit allows you to generate packing slips and shipping labels, sending branded tracking notifications and updating your eCommerce platform, Warehouse Management or Inventory Management system with tracking information.
## Before you begin
To integrate USPS with your Starshipit account you will need to have an EasyPost account. You can sign up for EasyPost [here.](https://www.easypost.com/signup?utm_sourc%20e=StarShipIt)
## How to set up USPS
1. In Starshipit, navigate to **Settings** > **Couriers** > **USPS**.
Please note your shipping from country will need to be United States.
2. Tick Enable **USPS**.
3. Enter your **EasyPost API Key**.
4. Enter your **EasyPost USPS Account ID**.
5. Click **Save**.
6. Click **Test to ensure it works** to ensure your credentials are valid.
7. Add your USPS Product codes.
## Available products
When using USPS with Starshipit, you can access a range of domestic and international shipping options to suit your delivery needs. Below is an overview of the available USPS services supported by Starshipit, including key features and delivery timeframes.
#### Domestic Services
**Ground Advantage**
* Used for domestic packages under 70lbs
* Fully tracked with delivery confirmation
* Cost-effective option for non-urgent shipments
**Priority Mail**
* Delivery in 1-3 business days
* Free boxes and envelopes available
* Includes tracking and insurance coverage up to $100
**Priority Mail Express**
* Fastest USPS service with overnight delivery to most locations
* Includes tracking, insurance and money-back guarantee
#### International Services
**Priority Mail International**
* Delivery in 6-10 business days to over 180 countries
* Tracking included for most destinations
**Priority Mail Express International**
* Delivery in 3-5 business days to many countries
* Includes tracking and insurance coverage up to $200
## Additional features
Using USPS via EasyPost integration with Starshipit allows users to select 'Signature Required' or 'Authority to Leave' on delivery.
## Configure USPS settings
| Setting | What it does |
| --- | --- |
| Enable USPS | Makes USPS available for shipment creation. |
| EasyPost API Key | Authenticates Starshipit with EasyPost. |
| EasyPost USPS Account ID | Identifies the USPS account in EasyPost. |
| Product codes | Add the USPS services enabled on the EasyPost account. |
| AES International Transaction Number (ITN) | Supplies the AES ITN for goods valued over US$2,500 when required for an international shipment. |
### USPS via Direct API
If USPS has issued enterprise credentials directly rather than an EasyPost account, use the separate **USPS (via Direct API)** setup.
| Setting | What it does |
| --- | --- |
| Enable USPS (via Direct API) | Turns the direct USPS connection on. |
| Use USPS test environment | Sends requests to the USPS test environment. |
| Account number and Account type | Identify the USPS enterprise account. |
| CRID | Identifies the USPS Customer Registration ID. |
| MID | Identifies the USPS Mailer ID. |
| Manifest MID | Identifies the MID used for manifesting. |
| Product codes | Select the USPS mail class codes available on your enterprise account. |
| Cancel shipment | Enter a tracking number on the Cancel shipment tab to submit a cancellation request. |
---
# Set up Zoom2u
URL: https://support.starshipit.com/articles/360000198075-set-up-zoom2u
Canonical: https://support.starshipit.com/articles/360000198075-set-up-zoom2u
Markdown: https://support.starshipit.com/articles/360000198075-set-up-zoom2u.md
Updated: 2026-02-05
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Step-by-step guide to setting up Zoom2u.
* Zoom2u is a courier marketplace that connects you with the best couriers across Australia. Zoom2u drivers provide you with VIP, 3-hour, and same-day delivery services, which can be booked online, and enables you to instantly see which driver will be delivering.
* Zoom2u’s [integration with Starshipit](https://www.starshipit.com/partner/zoom2u) allows you to use all of [Starshipit's features](https://www.starshipit.com/features) including generation of packing slips and shipping labels, auto-correction of addresses, branded tracking and notifications and many more.
* This article outlines how to set up Zoom2u for your Starshipit account.
## Setting up your Zoom2u account for Starshipit
The first step to activate your Zoom2u account in Starshipit is to get your Zoom2u API Key. You then 'Go Online', and then copy the API Key into Starshipit.
### 1. Getting your API key in the Zoom2u portal
1. Log into your Zoom2u account.
2. Go to **Profile**.
3. Copy your API Key.
4. Populate the WebHook URL with .
5. Click **Save**.
### 2. Go Online
Initially, the API Key is in test mode. Clicking on "Go Online" enables the creation of live bookings in Zoom2u, which then get offered to couriers. When in test mode ("Offline"), bookings are created as tests, which are not offered to couriers. This is to ensure the setup is correctly completed before actually going live.
## Screen_Shot_2018-05-16_at_10.16.40_AM.png
:::note
Do not switch to Online mode before full setup is complete. After full setup is complete, run a few test bookings to ensure the correctness of setup, and to check the booking data is being passed between the systems. The Zoom2u onboarding team can assist you with this.
:::
### 3. Copy your API key into Starshipit
Once you have your Zoom2u API key, you need to enter it in Starshipit.
1. In [Starshipit](https://app2.starshipit.com/), navigate to **Settings** > **Couriers** > **Add a new courier** > **Zoom2u**.
2. Populate the API field with the Zoom2u API Key.
3. Add your "3 hours" service code (as seen below).
4. Click Save.
Service codes available for Zoom2u are:
* 3 - 3 hour
* S - Same day
* V - VIP
### Other relevant information for you
To learn more about Zoom2u's integration with Starshipit, [click here](https://www.zoom2u.com.au/zoom2u-is-now-available-on-starshipit/).
## Configure Zoom2u settings
| Setting | What it does |
| --- | --- |
| Enable Zoom2u | Makes Zoom2u available for delivery creation. |
| API Key | Authenticates the Zoom2u connection. |
| Pickup scheduling method | Choose a pickup a number of minutes from now or schedule a specific date and time. |
| Minutes from now, Pickup date, and Pickup time | Define the pickup time according to the selected scheduling method. |
| Vehicle Type | Sets the vehicle required: Bike, Car, or Van. |
| Package Type | Sets the package type: Documents, Bag, Box, Flowers, or Custom. |
| Use generic description for items | Uses the generic package description from **Settings > Defaults** instead of individual item descriptions. |
| Product codes | Add the services enabled for your Zoom2u account, such as 3-hour, Same day, or VIP, and choose a default where appropriate. |
---
# Connect your systems to Starshipit
URL: https://support.starshipit.com/articles/90200000000401-connect-your-systems-to-starshipit
Canonical: https://support.starshipit.com/articles/90200000000401-connect-your-systems-to-starshipit
Markdown: https://support.starshipit.com/articles/90200000000401-connect-your-systems-to-starshipit.md
Updated: 2026-07-20
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Understand the four ways orders and fulfilment information can flow between your systems and Starshipit.
Connect your systems to Starshipit to bring orders in, create shipping labels, and send fulfilment and tracking updates back. Your business can use one connection flow or combine several.
## Choose how your orders should flow
- [Connect a sales channel directly](/articles/90200000000508-connect-a-sales-channel-directly) when Shopify, WooCommerce, Amazon, or another sales channel should send orders to Starshipit.
- [Connect a warehouse or inventory system](/articles/360001127975-warehouse-or-inventory-management-system-workflow) when that system controls your operational flow.
- [Create orders manually](/articles/90200000000509-choose-when-to-create-orders-manually) for low-volume or exceptional orders that do not come from another system.
- [Combine multiple connection flows](/articles/90200000000510-combine-multiple-connection-flows) when different stores, warehouses, clients, or order sources need different methods.
If there is no standard integration for your system, [choose a custom connection or file import](/articles/90200000000511-choose-a-custom-connection).
## Check technical requirements
Check whether your system needs access to [Starshipit IP addresses](/articles/360000516376-list-of-ip-addresses-that-require-access-to-your-platform) before you begin setup.
---
# Connect a sales channel directly
URL: https://support.starshipit.com/articles/90200000000508-connect-a-sales-channel-directly
Canonical: https://support.starshipit.com/articles/90200000000508-connect-a-sales-channel-directly
Markdown: https://support.starshipit.com/articles/90200000000508-connect-a-sales-channel-directly.md
Updated: 2026-07-20
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Understand how direct sales-channel integrations import orders and return fulfilment and tracking updates.
Connect a supported sales channel directly when it should send orders to Starshipit and receive fulfilment and tracking updates after you ship them.
## How the flow works
1. Shopify, WooCommerce, Amazon, or another sales channel sends eligible orders to Starshipit.
2. Your team fulfils the orders and prints shipping labels in Starshipit.
3. Starshipit sends tracking and fulfilment updates back to the connected sales channel.
This is usually the simplest option when the sales channel is the source of truth for orders and another warehouse or inventory platform does not need to control fulfilment.
## Before you connect
- Find your platform in the integration directory below.
- Read its setup guide to confirm supported order-import and writeback behaviour.
- Decide which order statuses should import.
- Connect each store as a separate integration when required by the platform.
If a warehouse or inventory platform controls allocation or despatch, use the [warehouse or inventory system workflow](/articles/360001127975-warehouse-or-inventory-management-system-workflow) instead.
---
# Connect a warehouse or inventory system
URL: https://support.starshipit.com/articles/360001127975-connect-a-warehouse-or-inventory-system
Canonical: https://support.starshipit.com/articles/360001127975-connect-a-warehouse-or-inventory-system
Markdown: https://support.starshipit.com/articles/360001127975-connect-a-warehouse-or-inventory-system.md
Updated: 2026-05-06
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Learn about Starshipit WMS and the third-party Inventory Management Systems and Warehouse Management Systems that Starshipit integrates with.
As your business grows, you may need a Warehouse Management System (WMS) or Inventory Management System (IMS) to manage inventory and meet demand efficiently. Starshipit offers its own built-in WMS, and also integrates with a range of third-party IMS and WMS platforms.
## Starshipit WMS
**Starshipit WMS** is Starshipit's native warehouse management system. It is designed to work alongside your existing Starshipit account and covers the full warehouse lifecycle — from receiving stock and managing locations through to picking, packing and outbound fulfilment.
Key capabilities include:
* Warehouse location management with barcode support
* Inbound receiving, putaway, and purchase orders
* Guided picking and packing workflows
* Inventory tracking, stocktakes, and cycle counts
* Replenishment and stock movement audit trail
Starshipit WMS connects directly to your Starshipit account. Orders, shipments, and key events stay in sync, so your existing automations, rules, and carrier integrations continue to work while the WMS manages what happens inside the warehouse.
You access Starshipit WMS at [wms.starshipit.com](https://wms.starshipit.com).
[Learn more about Starshipit WMS](/articles/starshipit-wms/getting-started/starshipit-wms-what-is-starshipit-wms)
## Third-party integrations
If you use an existing IMS or WMS, Starshipit integrates directly with those platforms so you can continue processing orders through Starshipit using your own freight accounts.
## Supported integrations
### Inventory Management Systems (IMS)
* [Brightpearl](/articles/integrations/inventory-warehouse-retail-management/how-to-integrate-with-brightpearl)
* [Cin7 Omni](/articles/integrations/inventory-warehouse-retail-management/cin7-integration-legacy)
* [Cin7 Core](/articles/integrations/inventory-warehouse-retail-management/cin7-core-integration)
* [NetSuite](/articles/integrations/inventory-warehouse-retail-management/netsuite-integration)
* [TradeVine](/articles/integrations/inventory-warehouse-retail-management/tradevine-integration)
* [Unleashed](/articles/integrations/inventory-warehouse-retail-management/unleashed-integration)
### Warehouse Management Systems (WMS)
* [Peoplevox](/articles/integrations/inventory-warehouse-retail-management/peoplevox-integration)
* [3PL Central](/articles/integrations/inventory-warehouse-retail-management/how-to-integrate-with-extensiv-formerly-3pl-central)
* [CartonCloud](/articles/integrations/inventory-warehouse-retail-management/how-to-integrate-with-cartoncloud)
## Multiple stores/locations
If you operate multiple stores or dispatch from different locations, you can set up a main Starshipit account that integrates directly to your WMS and courier. The main account will be connected to separate child accounts for each of your stores, each with different settings that apply to them. This allows you to ship from different locations/businesses using Starshipit, as outlined in the diagram below. Your WMS links to your eCommerce platform.
---
# Create orders manually
URL: https://support.starshipit.com/articles/90200000000509-create-orders-manually
Canonical: https://support.starshipit.com/articles/90200000000509-create-orders-manually
Markdown: https://support.starshipit.com/articles/90200000000509-create-orders-manually.md
Updated: 2026-07-20
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Understand when manual orders are suitable, their limitations, and where to find the order-creation steps.
Create orders manually when an order does not come from a connected system or when you only need to process occasional shipments.
## When manual orders make sense
Manual orders are useful for:
- One-off replacements or samples.
- Phone, email, or wholesale orders that are not stored in another connected system.
- Testing a courier or fulfilment workflow.
- Low-volume shipping without an order integration.
## Understand the limitations
A manually created order has no source integration to update. Starshipit cannot automatically write its fulfilment status or tracking number back to a sales channel, warehouse system, or inventory platform.
For recurring or high-volume orders, use a direct integration, CSV import, FTP connection, or the Starshipit API instead.
When manual entry suits the order, follow [Create a manual order](/articles/206358586-create-a-manual-order).
---
# Combine multiple connection flows
URL: https://support.starshipit.com/articles/90200000000510-combine-multiple-connection-flows
Canonical: https://support.starshipit.com/articles/90200000000510-combine-multiple-connection-flows
Markdown: https://support.starshipit.com/articles/90200000000510-combine-multiple-connection-flows.md
Updated: 2026-07-20
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Combine direct integrations, warehouse systems, manual orders, CSV imports, and API connections in one Starshipit operation.
Use multiple connection flows when your stores, clients, or order sources do not all follow the same operational path.
For example, one Starshipit operation can:
- Import retail orders directly from Shopify.
- Receive wholesale orders from a warehouse or inventory system.
- Import partner orders from CSV or FTP.
- Receive custom-platform orders through the API.
- Create occasional replacement orders manually.
## Design the flow
1. Identify the source of truth for each type of order.
2. Decide which system should control allocation, fulfilment, and tracking writeback.
3. Avoid connecting the same order source through two methods unless you have a deliberate deduplication process.
4. Test each flow with clearly identifiable orders before going live.
If you operate separate locations, brands, clients, or linked accounts, start with [Choose a multi-location or 3PL setup](/articles/90200000000405-choose-a-multi-location-or-3pl-setup).
If a standard integration is unavailable, [choose a custom connection or file import](/articles/90200000000511-choose-a-custom-connection).
---
# How fulfilment and tracking writeback works
URL: https://support.starshipit.com/articles/206358606-how-fulfilment-and-tracking-writeback-works
Canonical: https://support.starshipit.com/articles/206358606-how-fulfilment-and-tracking-writeback-works
Markdown: https://support.starshipit.com/articles/206358606-how-fulfilment-and-tracking-writeback-works.md
Updated: 2026-05-07
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Understand how Starshipit automatically updates your ecommerce platform with order status and tracking information through writeback.
## What is writeback?
When you generate a label, Starshipit sends the following information back to your selling channel or marketplace:
- **Order status**
- **Tracking number**
- **Carrier name**
This update can happen as soon as you print or when you manifest your orders. The default is set to write back on printing.
To change this to write back on dispatch, go to **Settings** > **Integrations** and enable **Write back order updates on manifest (otherwise it occurs on printing of labels)**.
### Example
1. You have an order in Magento which is imported into Starshipit.
2. The order has a status of **Pending** in Magento.
3. Once you process the order in Starshipit, Magento is automatically updated with the order status and tracking information.
:::note
Writeback is not available if you use Xero.
:::
---
# List of IP addresses that require access to your platform
URL: https://support.starshipit.com/articles/360000516376-list-of-ip-addresses-that-require-access-to-your-platform
Canonical: https://support.starshipit.com/articles/360000516376-list-of-ip-addresses-that-require-access-to-your-platform
Markdown: https://support.starshipit.com/articles/360000516376-list-of-ip-addresses-that-require-access-to-your-platform.md
Updated: 2026-05-06
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> This article contains an exhaustive list of IP addresses and domains for you to whitelist.
If you have implemented IP filtering on your eCommerce platform, you may need to whitelist our IP addresses. API traffic to `api.starshipit.com` currently originates from the IP address `52.237.217.63`. This IP is dedicated for outbound Starshipit API traffic and will remain static for all API requests.
## List of IP addresses to whitelist
### On port: 80, 443
* 125.236.193.73
* 13.70.65.114
* 13.70.65.145
* 13.70.67.84
* 13.70.71.54
* 13.70.71.83
* 13.70.72.35
* 13.73.195.135
* 13.75.138.224
* 193.56.253.248
* 20.188.208.134
* 20.53.214.57
* 20.92.152.254
* 20.92.156.8
* 20.92.157.172
* 20.92.157.230
* 20.92.157.243
* 20.92.158.151
* 20.92.158.179
* 20.92.158.19
* 20.92.158.221
* 20.92.158.37
* 20.92.158.6
* 20.92.208.162
* 20.92.208.164
* 20.92.208.191
* 20.92.209.127
* 20.92.209.191
* 20.92.209.249
* 20.92.209.91
* 20.92.210.145
* 20.92.211.128
* 20.92.211.187
* 20.92.211.217
* 20.92.211.225
* 52.147.2.39
* 52.147.2.6
* 52.147.24.109
* 52.147.29.26
* 52.147.3.4
* 52.147.4.3
* 52.187.229.183
* 52.187.231.76
* 82.26.106.4
## List of domain names to whitelist
The Starshipit Desktop App's Print Client connection requires access to the following domain names to connect and download a label.
### On port: 80, 443
* api.starshipit.com
* api.shipit.click
* printhub.starshipit.com
* printhub.shipit.click
* app.starshipit.com
* app.shipit.click
---
# Choose a custom connection
URL: https://support.starshipit.com/articles/90200000000511-choose-a-custom-connection
Canonical: https://support.starshipit.com/articles/90200000000511-choose-a-custom-connection
Markdown: https://support.starshipit.com/articles/90200000000511-choose-a-custom-connection.md
Updated: 2026-07-20
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Compare the Starshipit API, manual CSV imports, and automated CSV imports over FTP.
Choose a supported custom connection when Starshipit does not provide a standard integration for your sales channel or business system.
## Compare the options
| Option | Best for | What you need |
| --- | --- | --- |
| Starshipit API | Automated, real-time, or deeply customised workflows | A developer who can build and maintain an API integration |
| CSV file import | Occasional or batch order imports | A file that can be mapped to Starshipit order fields |
| CSV import via FTP | Automated file-based imports and tracking exports | An FTP server and consistently formatted CSV files |
You can combine these methods with direct integrations and manual orders. The best option depends on order volume, how quickly orders must appear, whether tracking must write back automatically, and who will maintain the connection.
## Continue with your connection
- Read the [Starshipit API overview](/articles/115004758523-starshipit-api-overview) before committing development work.
- Set up a [CSV file integration](/articles/204503255-csv-file-integration) for manual file imports.
- Use [CSV import via FTP](/articles/115001655223-csv-import-via-ftp) for an automated file workflow.
The endpoint reference and developer implementation guidance remain in the [Developer Center](/developers).
---
# CSV FAQs
URL: https://support.starshipit.com/articles/203679629-csv-faqs
Canonical: https://support.starshipit.com/articles/203679629-csv-faqs
Markdown: https://support.starshipit.com/articles/203679629-csv-faqs.md
Updated: 2026-05-06
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Find answers to common questions about CSV file imports, including column requirements, weight units, and shipping method values.
#### Are all of the columns required?
No.
#### If there are multiple items in an order, what is the 'item name'?
Create a different line for each item with the same Order Number.
#### What units are expected in the weight field?
Kgs.
#### Can you please supply a valid list of values for the shipping method field?
You can add anything you want in the shipping method field. You can define which shipping method matches with which courier product code by going to **Settings** > **Rules**.
---
# Find your Starshipit API key
URL: https://support.starshipit.com/articles/360001893576-find-your-starshipit-api-key
Canonical: https://support.starshipit.com/articles/360001893576-find-your-starshipit-api-key
Markdown: https://support.starshipit.com/articles/360001893576-find-your-starshipit-api-key.md
Updated: 2026-05-06
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Learn how to find your Starshipit api key.
Access a unique Starshipit API key and Subscription Key, which can be used to push orders from any platforms that we don't support natively.
## Finding your API key
1. Go to [Starshipit.](https://app2.starshipit.com/)
2. Navigate to **Settings** > **API**.
* Copy the displayed API key.
* To regenerate a new API key, use the **Regenerate** button.
* To regenerate a new Subscription key, use the **Regenerate** button.
3. Click **Save**.
For more information on how to use the Starshipit API, please refer to our API support documentation in the [Developer Center](/developers).
---
# Starshipit API Overview
URL: https://support.starshipit.com/articles/115004758523-starshipit-api-overview
Canonical: https://support.starshipit.com/articles/115004758523-starshipit-api-overview
Markdown: https://support.starshipit.com/articles/115004758523-starshipit-api-overview.md
Updated: 2026-05-06
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Build one API integration to access all courier integrations, powerful automation, and branded notifications without building separate connections to each carrier.
Starshipit integrates with the world's leading eCommerce and online platforms. Our app enables you to seamlessly integrate your online store with your couriers. However, sometimes our integrations don't work for some larger or enterprise retailers. This might be because Starshipit doesn't integrate with the online platforms you use, or because you've built a custom website. If you want to integrate with your couriers directly, you will have to build your own API integrations: one each for each of the couriers you want to integrate with.
Starshipit has already done the hard work of integrating with your couriers for you. Use the Starshipit API to build your own integration with your eCommerce and online platforms. Then you will have access to our full arsenal of features including a powerful rules engine and integrations with [the world's leading domestic and international couriers](https://www.starshipit.com/integrations).
## Benefits of integrating with the Starshipit API
* Using the Starshipit API means that you only need to build one API integration (the one between your platform and Starshipit). If you wanted to integrate directly with your couriers but didn't connect with Starshipit, you would have to build one API for each courier.
* Using our API saves large retailers and enterprise companies loads of time and money, because we have already done the hard work integrating with the couriers for you. All you need to do is integrate with us.
* Because you are integrating with just one API, instead of building out multiple integrations of your own, you can easily add additional couriers to your logistics processes. Using our API gives you immediate access to all our couriers (you just need to have an active account with them).
* By integrating with our API, you gain access to our full arsenal of features, including:
+ An intuitive user interface that you can access anywhere in the world, which clearly shows you which orders are ready to ship and which have shipped, and enables easy orders, generating reports, tracking status updates, and creating returns
+ Label printing, packing slips and customs documentation
+ Branded email and SMS notifications, and branded tracking pages
+ A powerful rules engine that you can use to fully automate your dispatch processes, and amend at any time to change how your orders are sent out
* We generate labels locally for the below couriers so if their APIs go down you can continue printing labels:
+ CourierPost
+ NZ Post (supported for some services)
+ Australia Post eParcel(supported for domestic shipments)
+ StarTrack
+ CouriersPlease (supported for outbound shipments)
+ Team Global Express Priority
+ Team Global Express IPEC
+ Pickup In Store
+ Plain Label
+ Zoom2u (we call the Zoom2u API to book the pickup when generating labels)
* We are fully integrated with DHL Express's Paperless Trade system, which lets you save money by not having to use so much paper and commit additional handling time with customs documentation.
* Retailers who use the Starshipit API can request production API access with a higher approved rate limit.
* Retailers who integrate with Starshipit can use our other integrations as well, e.g. you could connect some orders into Starshipit via the API, and others through other channels like Shopify, Magento, and Zapier.
* Our dedicated customer support team is available via phone and email. Our Customer Success team is also available at any time to help you onboard and optimise your Starshipit experience. Both services are free.
* You will have access to any new features, platforms and couriers as we add them to our services.
* We are very stable during peak periods and on average we process over half a million labels every day.
* Starshipit is hosted on Microsoft Azure which grants us limitless scalability when extra performance is required during busy periods.
* Starshipit is not an aggregator, we are an enabler. This means that you maintain control over your relationship with your couriers and the rates you have negotiated with them. We do not charge an order processing fee per label, just your monthly base fee.
### What's next?
Read more about [the Starshipit API](/developers) and how to get started.
If you want a guided entry point that also covers Product Catalogue and troubleshooting, start at the [Developer center](/developers).
---
# CSV file integration
URL: https://support.starshipit.com/articles/204503255-csv-file-integration
Canonical: https://support.starshipit.com/articles/204503255-csv-file-integration
Markdown: https://support.starshipit.com/articles/204503255-csv-file-integration.md
Updated: 2026-05-06
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Set up and import orders from a CSV file into Starshipit using our template or your own customized mapping.
If your eCommerce platform is not on the list of supported platforms, you can extract your orders from a CSV file and import them into Starshipit. You can use our default CSV template or customize your own CSV file with custom field mappings.
## Set up your CSV import
**CSV file requirements:**
* You must add one piece of data per column.
* You must add one item per line (if there are two items in one order, add two lines with the same order number).
* Each order number must be unique.
In **Settings***>***CSV File Setup** you have the following import options:
1. Use the Starshipit preformatted template
Download the [Starshipit CSV template](https://app.shipit.click/ClientBin/starshipit_csv_template.csv) containing default field mappings.
2. Use the WIX CSV template
If you are using Wix you can extract your orders from WIX and import them in Starshipit using CSV. To map your spreadsheet data to our column headers, you need to select rows from the 'Available Column' section and drag and drop them into the 'CSV File Columns' section. You can't delete the required columns in the right-hand side section, however, you can reorder them to based on your business needs.
:::note
Tip If your CSV file has additional columns, add a blank row in the order they appear so it doesn't break the import. Ensure you have valid addresses for all your orders.
:::
3. Map your own customised CSV
You can use your own CSV and map the column in Starshipit. The mapping interface has two columns. The column on the left represents all available fields available, and the column on the right represents your CSV file.
:::note
Tip You'll need to drag and drop the labels, so the label on top will be the first column of your CSV file. The second label will be the second column of your CSV file. Make sure that you save your changes.
:::
## Import using a CSV file
1. In the **Orders** screen, click **Import**, then select **Upload CSV File**.
2. Select a CSV file from your computer, then click **Import CSV**.
3. Click **Close**, when the import is complete.
## FAQs
What do all the columns represent, and are they required?
Please refer to the following table which has a list of all the columns in our template:
| | | |
| --- | --- | --- |
| **Field Name** | **Required** | **Impact** |
| Order Number | No | When left empty, the system will generate an order number based on OurRef field in the settings. |
| Date | No | When left empty, the system will create the import date as the order date. |
| To Name | **Yes** | |
| Destination Building | No | When left empty, this field will remain empty in the order. |
| Destination Street | **Yes** | |
| Destination Suburb | **Yes** | |
| Destination City | No | When left empty, the system will populate the city value using the suburb value during shipment creation (label print). |
| Destination Postcode | **Yes** | |
| Destination State | No | When the state is mandatory (e.g. shipping to Australia); shipment creation will fail and an error is returned. |
| Destination Country | **Yes** | |
| Destination Email | No | When left empty, this field will remain empty in the order. For some carriers, this field is mandatory in which case an error occurs and SSI notifications will not be triggered if they are enabled. |
| Destination Phone | No | When left empty, this field will remain empty in the order. For some carriers, this field is mandatory in which case an error occurs and SSI notifications will not be triggered if they are enabled. |
| Item Name | No | Item isn't mandatory for domestic shipments. However, it is mandatory for international shipments. Validation error will be returned during shipment creation/label print. |
| Item Price | No | When left empty, the item price will be set to $0, which will also be passed to the commercial invoice. |
| Instructions | No | When left empty, this field will remain empty in the order. |
| Weight | No | Item is mandatory for international shipments; when left empty, the system will calculate the weight as 0.001 kg. |
| Shipping Method | No | When left empty, this field will remain empty in the order. |
| Reference | No | When left empty, this field will remain empty in the order. |
| SKU | No | Item isn't mandatory for domestic shipments. However, it is mandatory for international shipments. Validation error will be returned during shipment creation/label print. |
| Qty | No | When left empty; the quantity to ship will be set to 1. |
| Company | No | When left empty, this field will remain empty in the order. |
| Signature Required | No | When left empty, this field is set to "No". |
| ATL | No | When left empty, this field is set to "No". |
| Country Code | No | When left empty, this field is set to the destination country code. |
| Package Height | No | When left empty, the height will be set to 1 cm. |
| Package Width | No | When left empty, the width will be set to 1 cm. |
| Package Length | No | When left empty, the length will be set to 1 cm. |
| Carrier | No | When left empty, the default carrier is assigned to the shipment. |
| Carrier Product Code | No | When left empty, the default carrier product is assigned to the shipment. |
| Carrier Product Unit Type | No | When left empty, this field will remain empty in the order. |
| Declared Value Currency | No | When left empty, the default currency is applied, i.e., from the settings page. |
| Code | No | When left empty, this field will remain empty in the order. |
| Color | No | When left empty, this field will remain empty in the order. |
| Size | No | When left empty, this field will remain empty in the order. |
| Contents | No | When left empty, contents are populated to the default package dimensions applied. |
| Dangerous Goods | No | When left empty, this field is set to "No". |
| Country of Manufacturer | No | When left empty, this field will remain empty in the order. Note: If it's an international shipment, for example, a carrier like DHL will return an error. |
| DDP | No | When left empty, this field is set to "No". |
If there are multiple items in an order, what is the 'item name'?
Create a different line for each item with the same Order Number.
What units are expected in the weight field?
Kgs (Kilograms).
Can you please supply a valid list of values for the shipping method field?
You can add anything you want in the shipping method field. You can define which shipping method matches with which courier product code in *Settings > Rules*.
How do I specify multiple packages for the same order?
Create a different line for each package dimensions with the same Order Number.
---
# CSV import via FTP
URL: https://support.starshipit.com/articles/115001655223-csv-import-via-ftp
Canonical: https://support.starshipit.com/articles/115001655223-csv-import-via-ftp
Markdown: https://support.starshipit.com/articles/115001655223-csv-import-via-ftp.md
Updated: 2026-05-06
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Automatically import orders from CSV files on your FTP server and receive tracking information back after printing.
If you are using an eCommerce platform where there is no direct integration with Starshipit, you can set up automatic CSV file imports from an FTP server. CSV files will be downloaded from your server and the shipment tracking information will be written back to your server after printing.
## 1. Set up your CSV file template in Starshipit
The first step is to set up your CSV file template in Starshipit. We recommend you test your CSV file template by performing a manual import first, before you start using the automated FTP server import.
[Learn more about setting up your CSV template.](/articles/integrations/csv/csv-file-integration)
## 2. Set up your FTP server details in Starshipit
Enter the connection information about your FTP server:
1. In Starshipit, navigate to **Settings** > **Integrations** > **Add a new integration**> **CSV FTP.**
2. Tick **Enable CSV FTP**.
3. Enter the address of your server and port.
4. Enter the FTP user credentials.
5. Click **Save.**
6. Click **Test to ensure it works**to validate that your credentials are correct.
:::note
Starshipit automatically creates three folders: IN, OUT, and HISTORY. The folders can also be created manually, however, the names of the folders are case-sensitive.
:::
## 3. Import your orders and get the tracking information.
Once your FTP server details are added to Starshipit, you will have three folders:
* **IN** contains the CSV files that need to be imported. Once a file has been imported into Starshipit, it is moved to HISTORY.
* **HISTORY** contains the CSV files that have been imported into Starshipit.
* **OUT** contains the tracking information of the printed orders: Tracking Number, Order Number, Customer Name, Courier Company, Tracking URL. One file is created per order.
---
# Automatically import orders via CSV using File Monitor
URL: https://support.starshipit.com/articles/4403712212111-automatically-import-orders-via-csv-using-file-monitor
Canonical: https://support.starshipit.com/articles/4403712212111-automatically-import-orders-via-csv-using-file-monitor
Markdown: https://support.starshipit.com/articles/4403712212111-automatically-import-orders-via-csv-using-file-monitor.md
Updated: 2026-05-07
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Learn how to use the File Monitor to automatically import orders from CSV files.
When using Starshipit in your browser, you can [bulk upload orders directly into your account](/articles/integrations/csv/csv-file-integration). The File Monitor takes this further by watching a folder on your computer and automatically importing CSV files into Starshipit as orders. To find the supported file template, go to [CSV File Setup in Starshipit](https://app.starshipit.com/Members/Settings/Integration/CSVSetup.aspx).
## Set up the File Monitor
1. Open the **Starshipit Desktop App** on your computer.
2. In the menu bar, click **CSV File Monitor** > **Settings**.
3. Tick **Enable CSV File Monitor**.
4. Beside **Directory to watch**, click **Browse** to instruct the File Monitor where to find CSV files to upload from.
5. Beside **Directory where successful files are moved**, click **Browse** to instruct the File Monitor where to move files to once they have been successfully uploaded.
6. Beside **Directory where files with errors are moved**, click **Browse** to tell the File Monitor where to move files to if they have returned errors during upload.
7. Tick **Enable Writeback of Tracking Numbers**.
This will retrieve tracking numbers for printed unmanifested orders and place in the specified folder every 5 minutes.
8. Beside **Directory to writeback tracking numbers**, click **Browse** to tell the File Monitor where to move files for tracking numbers.
9. Click **Save** then **Close**.
:::note
Once the auto-import setting is enabled, the Print App will monitor the folder you specified to read CSV files in real time. The app will then push it to Starshipit over the API using HTTPS.
:::
## Upload orders with File Monitor
Once set up, you can begin uploading orders into the print app. To upload orders:
1. Ensure that the app is running on your computer.
2. Open the folder you selected as the folder to read CSV files from.
3. Copy paste in (or drag and drop) the CSV file which contains the information for the orders you'd like to upload, into the folder you've selected as the **f****older to read CSV files from**.
4. Once added, StarshipIt will automatically begin uploading the orders.
5. Imported orders will appear in the **New** tab of the Print App and also be available in the **New** tab of the Starshipit web app.
If all orders are imported successfully, the CSV file will be moved to the folder you selected during setup in Step 4. It will also have **_IMPORTED** added to the end of the file name.
If any orders cannot be successfully imported, the CSV file will be moved to the folder you selected during setup in Step 5. It will also have **_ERROR** added to the end of the file name.
## Troubleshooting
File Monitor creates a log of all order imports which can be found by going to **Tools** > **Open Log Folder**.
To see why an order failed to upload, go to **Tools** > click **Open Log Folder** > click to open the **importLog** file.
---
# Connect Adobe Commerce (Magento 2) to Starshipit
URL: https://support.starshipit.com/articles/213430403-connect-adobe-commerce-magento-2-to-starshipit
Canonical: https://support.starshipit.com/articles/213430403-connect-adobe-commerce-magento-2-to-starshipit
Markdown: https://support.starshipit.com/articles/213430403-connect-adobe-commerce-magento-2-to-starshipit.md
Updated: 2026-09-03
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Integrate your Adobe Commerce (previously Magento) platform with Starshipit using token or user authentication to import orders and write back tracking information.
Integrate your Adobe Commerce platform (previously Magento) with Starshipit using token or user authentication to import orders and write back tracking information.
:::important
Adobe Commerce 2.4 uses two-factor authentication by default, so use **Token** authentication. In Adobe Commerce 2.4.4, also allow OAuth access tokens to be used as standalone bearer tokens under **Stores > Configuration > Services > OAuth > Consumer Settings**.
:::
## Before you begin
You need your Adobe Commerce store URL and an authentication method. **Token** authentication is recommended.
## Create an access token
1. In Adobe Commerce, go to **System > Extensions > Integrations**.
2. Click **Add New Integration** and enter `Starshipit` as the name.
3. Enter your Adobe Commerce admin password, then open the **API** tab.
4. Under **Resource Access**, select **All**, then click **Save**.
5. Back on the Integrations page, click **Activate** for Starshipit and then **Allow**.
6. Copy the **Access Token** from the confirmation dialog. You do not need the consumer key, consumer secret, or access-token secret.
## Connect Adobe Commerce in Starshipit
1. Go to **Settings > Integrations > Add a new integration > Adobe Commerce**.
2. Turn on **Enable Adobe Commerce**.
3. Select **Token** authentication and enter your store URL and access token.
4. Choose the order status or statuses to import. Separate multiple statuses with a semicolon.
5. Click **Save**, then use **Test connection** and confirm a test order imports as expected.
Can I use user authentication instead?
Yes. In Adobe Commerce, create an **Integration** user role with **All** resource access. Create a user, assign that role, then enter the username and password in Starshipit. Use token authentication when possible.
## Optional order fields
To offer delivery instructions, authority to leave, or signature-required choices at checkout, create these Adobe Commerce custom fields:
```
delivery_comment (String max 100) for the delivery instruction
authority_to_leave: values can be 0, 1, true, false, yes or no
signature_required: values can be 0, 1, true, false, yes or no
```
:::note
Add these fields to the `/rest/V1/orders/` order-search criteria API.
:::
Turn on **Import bundle items** only when you need bundle lines to import. Bundle details appear on customised packing slips; ship-together bundles are not supported.
## Configure Adobe Commerce settings
Complete the following fields when you connect Adobe Commerce (Magento 2). You can update them later from **Settings > Integrations > Adobe Commerce (Magento 2)**.
| Setting | What it controls |
| --- | --- |
| **Enable Magento2** | Turns the connection on or off. |
| **Authentication** | Choose **User** authentication or **Token** authentication. Token authentication is recommended for Adobe Commerce 2.4. |
| **Store URL** | The base URL of your Adobe Commerce store. |
| **Access Token** | The token used for Token authentication. |
| **Username** and **Password** | Credentials used for User authentication. |
| **User Agent** | Optional value sent to Adobe Commerce to identify Starshipit requests. |
| **Status** | Selects the Adobe Commerce order status to import. |
| **Disable writeback** | Stops Starshipit from sending shipment and tracking updates back to Adobe Commerce. |
| **Use base currency value fields** | Uses Adobe Commerce base-currency values when importing order amounts. |
| **Map address line 2 to building field** | Maps address line 2 into Starshipit's Building field. |
| **Import bundle items** | Imports bundle items. Bundle details are available on customised packing slips; ship-together bundles are not supported. |
| **Unit of Measurement** | Selects the unit used when importing product dimensions. |
Click **Save** after changing settings. Use **Test connection** to verify the connection and confirm that a test order imports with the expected status.
---
# Set up product dimensions in Magento 2
URL: https://support.starshipit.com/articles/5882363781647-set-up-product-dimensions-in-magento-2
Canonical: https://support.starshipit.com/articles/5882363781647-set-up-product-dimensions-in-magento-2
Markdown: https://support.starshipit.com/articles/5882363781647-set-up-product-dimensions-in-magento-2.md
Updated: 2026-05-06
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Step-by-step guide to setting up product dimensions in Magento 2.
You can add product dimensions to Magento 2, which Starshipit then reads on import and uses for rates at checkout. Magento 2 uses an attribute system to manage product information like size and colour. To use dimensions in Starshipit you'll need to create custom attributes in your Magento 2 settings.
## How it works
To start, you will need to create the following custom attributes in Magento 2:
* Length
* Height
* Width
Note: Ensure you follow the exact spelling. Capitalisation (Length vs length) doesn’t matter.
## Add a custom attribute in Magento 2
1. Go to the **Admin Panel**.
2. Click **Stores**.
3. Click **Attributes**.
4. Click **Product**.
5. Click **Add Attribute**.
6. Click **Create New Attribute**.
7. Set the name of the attribute in the field **Attribute Label** as **Length**.
8. Leave the Catalog input Type as "Text Field".
9. You don't need to change the **Required** toggle.
10. Click **Save Attribute**.
Repeat the above steps to create attributes for **Height** and **Width.**
## Notes
* All custom attributes created for one product will be created for all products as empty fields. If the fields are empty or if you set a non-numeric character in the dimension, then it will assume zero when getting rates.
* Once the attributes are created, it will start working next time a customer adds this product to their shopping cart.
* If your dimensions aren’t pulling through, change the attribute code to all lower case.
* When importing orders from Magento 2, the dimensions come through to Starshipit in meters (m).
* When you open an order, you’ll see the imported dimension converted according to the Display Sizes Unit you’ve set in Settings > Options.
---
# Connect Amazon to Starshipit
URL: https://support.starshipit.com/articles/206090475-connect-amazon-to-starshipit
Canonical: https://support.starshipit.com/articles/206090475-connect-amazon-to-starshipit
Markdown: https://support.starshipit.com/articles/206090475-connect-amazon-to-starshipit.md
Updated: 2026-07-21
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Integrate your Amazon stores with Starshipit to import orders and automatically write back tracking information.
Starshipit currently supports the below marketplaces. If a country you wish to set up in Starshipit is not listed, please raise a feature request with our support tean [here](https://help.starshipit.com). The full list of current Amazon marketplaces can be found [here](http://docs.developer.amazonservices.com/en_US/dev_guide/DG_Endpoints.html).
| | | | |
| --- | --- | --- | --- |
| Australia | France | Netherlands | Sweden |
| Brazil | Germany | Poland | Turkey |
| Canada | India | Saudi Arabia | United Arab Emirates |
| Egypt | Italy | Singapore | United Kingdom |
| Japan | Mexico | Spain | United States |
## What you need to get started
* The Amazon Marketplace you are integrating with
* Your Amazon username and password
## How to set up Amazon SP-API
* You can integrate as many Amazon Marketplaces into your Starshipit account as you like.
* Starshipit integrates with Amazon MWS and Amazon SP-API. Amazon MWS will be deprecated at the end of July 2022. We recommend all users set up Amazon SP-API.
* Starshipit supports Amazon FBA & FBM in Australia and United Kingdom.
1. Go to **Settings** > **Integrations** > **Add a new integration** > **Amazon**.
2. Tick **Enable Amazon**.
3. Select **Amazon Selling Partner API** as the API type.
4. Select the Market Place from the Amazon Market Place drop down.
5. Click **Authorise**, this will redirect you to Amazon to log in.
6. Provide Starshipit access to your Amazon store.
7. Once done, you will be redirected back to Starshipit and the integration will be good to go.
## Additional Configuration
**Status to import**: Use this option to select what status orders should be in to import into Starshipit
### Import only Amazon Self Ship orders
Amazon Easy Ship orders are imported by default. If you only fulfil Amazon Self Ship orders through Starshipit:
1. Go to **Settings > Integrations > Amazon**.
2. Turn off **Import Amazon Easy Ship orders**.
3. Click **Save**.
Starshipit will continue importing Amazon Self Ship orders and skip Amazon Easy Ship orders.
## (LEGACY) How to set up Amazon MWS
### Add Amazon MWS Developer Permission
:::warning
These instructions only work if you have aSeller Central Professionalaccount.
:::
1. Log into your Amazon seller central account.
2. Hover over **Settings** in the very top right then click **User Permissions**from the dropdown.
3. Scroll to Amazon MWS Developer Permissions and click on the **Visit Manage Your Apps** button.
4. Click on the **Authorize New Developer** button.
5. For Developer's Name enter **Starshipit**.
6. For Developer ID enter one of the following options:
* Use **1817-8885-3340** for Amazon **Australia/Singapore/Japan** Marketplace
* Use **4642-1105-5661** for Amazon **Americas** Marketplace
* Use **0305-7714-1617** for Amazon **UK/Europe/Middle East** Marketplace.
7. Click on the **Next** button.
8. Click on the **Next** button to confirm access.
:::note
Please note down your Seller IDand MWS Auth Tokenfor the next step.
:::
### Set up Amazon integration in Starshipit
1. Log into **Starshipit**.
2. Click **Settings** in the very bottom left then select **Integrations**.
3. Click **Add a new integration** and select **Amazon**.
4. Tick the **Enable Amazon** tick box.
5. Enter your **Seller ID.**
6. Enter your **MWS Auth Token**.
7. Select your Amazon Marketplace.
8. Set your **Status to Import**.
9. Click on the **Save** button.
## Configure Amazon settings
Complete these settings during Amazon setup. You can update them later from **Settings > Integrations > Amazon**. The available controls depend on whether you use Selling Partner API (SP-API) or the legacy MWS connection.
| Setting | What it controls |
| --- | --- |
| **Enable Amazon** | Turns this Amazon connection on or off. |
| **API type** | Selects **Amazon Selling Partner API** or legacy **MWS**. New connections use SP-API. |
| **Marketplace** | Selects the Amazon marketplace that supplies orders for this connection. |
| **Seller ID** | Identifies your Amazon seller account. For SP-API, this value is populated during authorisation; for MWS, enter the Seller ID from Amazon. |
| **MWS Auth Token** | Authenticates a legacy MWS connection. This field appears only when MWS is selected. |
| **Status to import** | Limits imports to the selected Amazon order statuses. Separate multiple statuses with a semicolon. |
| **Remove batching** | Turns off batching during import. Batching improves import performance, so use this when you are not importing all orders. |
| **Use Amazon Easy Ship** | Enables Easy Ship handling when the selected marketplace supports it. |
| **Import Amazon Easy Ship orders** | Includes Easy Ship orders in imports. Turn this off when you fulfil only Self Ship orders. |
| **Map address line 2 to building** | Maps Amazon address line 2 into Starshipit's Building field; otherwise it is mapped to the suburb field. |
Click **Save** after changing a setting. Use **Authorise** or **Reauthorise** after changing the Amazon authorisation, then use **Test connection** in the Tools tab to verify access.
---
# Amazon Best Practices: Confirming Shipments
URL: https://support.starshipit.com/articles/4737847262223-amazon-best-practices-confirming-shipments
Canonical: https://support.starshipit.com/articles/4737847262223-amazon-best-practices-confirming-shipments
Markdown: https://support.starshipit.com/articles/4737847262223-amazon-best-practices-confirming-shipments.md
Updated: 2026-05-06
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Learn best practices for confirming shipments to maintain a positive seller rating.
* [Amazon: How to Confirm a Shipment](https://sellercentral.amazon.com.au/gp/help/external/200197960?language=en_AU)
* [Amazon: Seller Best Practices](https://sellercentral.amazon.com.au/gp/help/external/help.html?itemID=200587810)
## Automate the confirmation process
The data (particularly the tracking number) that is required for confirmation in Amazon is generated in Starshipit when you print a label. Starshipit will automatically complete the confirmation process for you through our [writeback functionality](/articles/orders-manifests-reports/faqs/does-starshipit-automatically-update-my-integrated-ecommerce-platform). The writeback to Amazon will send back the ship date, carrier name, shipping method, and tracking ID via an API connection directly to Amazon.
## Starshipit Recommendations
* To ensure that the confirmation occurs quickly, you can configure your account to write back the tracking information as soon as you print the label:
**Settings** > **Integrations** > Untick **Write back order updates on manifest** (otherwise it occurs on printing of labels).
* If you would like to automate the printing of your labels so that the tracking can be provided as soon as the order is placed in Starshipit, try [Zapier](/articles/integrations/accounting-other-platforms/zapier-integration). Using this tool you can create a Zap that is triggered when a new order is detected in your account, and then sends the order to the printer.
* If you print the order before you are actually able to dispatch the order, you may need to reprint the label. For information on how to do this, please see here: [Shipping Label FAQ.](/articles/printing-labels-packing-slips/labels/shipping-label-faqs)
---
# Amazon: Troubleshooting
URL: https://support.starshipit.com/articles/360001580356-amazon-troubleshooting
Canonical: https://support.starshipit.com/articles/360001580356-amazon-troubleshooting
Markdown: https://support.starshipit.com/articles/360001580356-amazon-troubleshooting.md
Updated: 2026-05-06
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Learn how to troubleshoot and resolve common issues with Amazon.
## Error: Queued for Amazon update
If you get a writeback error when importing Amazon orders, your Amazon API connection has been throttled.
Every shipment that you process between your store and the Amazon API requires a request to be made. 'Throttling' is the term used to describe the quota that the Amazon API has on the amount of requests a third party can make during a particular timeframe. Unfortunately, the number of requests Amazon allows is low.
Starshipit will automatically reattempt to update the order in Amazon every few hours. After several reattempts Starshipit will stop, however, you can manually retrigger the writeback:
1. Select the orders in the orders screen you would like to update.
2. Right-click then select **update selected orders in source system**.
3. Starshipit will add the orders to the writeback queue to reattempt updating them.
4. Refresh the page. If the orders now show a writeback status of **up to date**, then the re-attempt was successful.
---
# Configure BigCommerce order data and storefronts
URL: https://support.starshipit.com/articles/90200000000507-configure-bigcommerce-order-data-and-storefronts
Canonical: https://support.starshipit.com/articles/90200000000507-configure-bigcommerce-order-data-and-storefronts
Markdown: https://support.starshipit.com/articles/90200000000507-configure-bigcommerce-order-data-and-storefronts.md
Updated: 2026-07-20
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Configure Authority to Leave, product options, pickup orders, and multiple BigCommerce storefronts in Starshipit.
Configure the additional BigCommerce data and storefront behaviour during setup. You can update these choices later from **Settings > Integrations > BigCommerce**.
## Import Authority to Leave
To import Authority to Leave from BigCommerce:
- Name the billing form field **Delivery Option**.
- Set its value to include either `authority to leave` or `signature required`.
## Import product options
Starshipit imports BigCommerce product options with these display names:
- Size
- HS Code
- Color or Colour
To also import bin and warehouse values, [configure BigCommerce product locations](/articles/205452843-bigcommerce-product-location).
## Enable pickup orders
1. Open the BigCommerce integration settings in Starshipit.
2. Enable **Pickup in Store**.
3. Click **Save**.
When a pickup shipment is printed, Starshipit writes it back to BigCommerce as **Awaiting Pickup**.
## Manage multiple storefronts
Enable **Import Channel ID as a tag** to add each order's storefront ID as a Starshipit tag. You can use that tag to filter the orders grid or create storefront-specific shipping rules.
1. Go to **Settings > Integrations > BigCommerce**.
2. Enable **Import Channel ID as a tag**.
3. Click **Save**.
4. Import a test order from each storefront and confirm the expected tag appears.
Starshipit supports tracking writeback for orders imported from multiple BigCommerce storefronts.
## Configure BigCommerce settings
Complete these connection and advanced options during setup, or update them later when your BigCommerce workflow changes:
| Setting | What it controls |
| --- | --- |
| **Name** | Identifies the BigCommerce store in Starshipit. |
| **API Path** | The BigCommerce store API path from the store-level API account. |
| **Username** | The legacy username field. Leave it empty when using a V2/V3 API token. |
| **Access Token** | Authenticates Starshipit with BigCommerce. Keep it secret. |
| **Client Id** | The client ID from the BigCommerce store-level API account. |
| **Statuses to import** | Limits imports to the BigCommerce status codes you enter. |
| **Enable writeback to BigCommerce orders to create shipment details** | Sends shipment details back to BigCommerce when orders are fulfilled. |
| **Status to set** | Sets the BigCommerce status during writeback. |
| **Enable Pickup in Store** | Writes pickup shipments back as **Awaiting Pickup**. |
| **Map address line 2 into “Building” field** | Maps BigCommerce address line 2 to Starshipit's Building field. |
| **Import Channel ID as a tag** | Adds the BigCommerce storefront channel ID as an order tag in Starshipit. |
| **Enable AfterShip tracking links** | Sends BigCommerce's mapped carrier so it can generate an AfterShip link. Leave this off to preserve direct carrier tracking links. |
Click **Save** in the section where you changed a setting, then use **Test connection** to verify the connection.
---
# Connect BigCommerce to Starshipit
URL: https://support.starshipit.com/articles/204502815-connect-bigcommerce-to-starshipit
Canonical: https://support.starshipit.com/articles/204502815-connect-bigcommerce-to-starshipit
Markdown: https://support.starshipit.com/articles/204502815-connect-bigcommerce-to-starshipit.md
Updated: 2026-07-20
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Create a BigCommerce API account and connect it to Starshipit so orders and tracking information can stay in sync.
Connect BigCommerce to Starshipit so you can import orders and write tracking information back when labels are printed.
## Before you begin
You need admin access to both BigCommerce and Starshipit.
## Create an API account in BigCommerce
1. In BigCommerce, [create a store-level API account](https://support.bigcommerce.com/articles/Public/Store-API-Accounts).
2. Select **V2/V3 API token**.
3. Set the following OAuth scopes and leave unlisted scopes unchanged.
| Name | Scope |
| --- | --- |
| Content | modify |
| Checkout Content | modify |
| Customers | modify |
| Customers Login | login |
| Information & Settings | modify |
| Marketing | modify |
| Orders | modify |
| Order Transactions | modify |
| Create Payments | create |
| Get Payment Methods | read-only |
| Products | modify |
| Themes | modify |
| Carts | modify |
| Checkouts | modify |
| Sites & Routes | modify |
| Channel Settings | modify |
| Channel Listings | modify |
| Storefront API Tokens | manage |
| Storefront API Customer Impersonation Tokens | manage |
:::important
Copy and securely store the **API Path**, **Client ID**, and **Access Token** when BigCommerce displays them. BigCommerce does not show these credentials again.
:::
## Connect BigCommerce in Starshipit
1. In Starshipit, go to **Settings > Integrations > Add a new integration > BigCommerce**.
2. Enter a name that identifies the store.
3. Leave **Username** empty.
4. Enter the **API Path**, **Client ID**, and **Access Token** from BigCommerce.
5. Click **Save**.
## Verify the connection
[Import BigCommerce orders](/articles/90200000000506-import-orders-from-bigcommerce) and confirm an eligible order appears in Starshipit.
## Shipment write-back
When you print a BigCommerce order, Starshipit writes the tracking number and shipping method back to the BigCommerce shipment. Where Starshipit can confidently match the selected courier to a BigCommerce-supported carrier, it also sends the matching carrier value for tracking. If there is no supported match, Starshipit keeps the shipping method and tracking number and does not guess a carrier.
---
# Import orders from BigCommerce
URL: https://support.starshipit.com/articles/90200000000506-import-orders-from-bigcommerce
Canonical: https://support.starshipit.com/articles/90200000000506-import-orders-from-bigcommerce
Markdown: https://support.starshipit.com/articles/90200000000506-import-orders-from-bigcommerce.md
Updated: 2026-07-20
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Select the BigCommerce statuses Starshipit should import and manually import eligible orders for the first time.
Configure which BigCommerce orders Starshipit imports, then run an import to verify the integration.
## Before you begin
[Connect BigCommerce to Starshipit](/articles/204502815-how-to-integrate-with-bigcommerce) before importing orders.
## Select order statuses
Use BigCommerce status codes to control which orders are eligible to import:
| Status | BigCommerce status | Typical use |
| --- | --- | --- |
| `9` | Awaiting Shipment | Import into Starshipit |
| `11` | Awaiting Fulfillment | Import into Starshipit |
| `2` | Shipped | Update an existing order |
| `10` | Completed | Update an existing order |
:::important
The selected statuses determine which orders appear in Starshipit and can affect fulfilment reporting.
:::
## Import orders
1. In Starshipit, open **Shipments**.
2. Click **Import**.
3. Select **BigCommerce** and the number of days to import.
4. Click **Import**.
5. Review the import count, then click **Close**.
Confirm the eligible BigCommerce orders appear on the Shipments page.
---
# BigCommerce: Product location
URL: https://support.starshipit.com/articles/205452843-bigcommerce-product-location
Canonical: https://support.starshipit.com/articles/205452843-bigcommerce-product-location
Markdown: https://support.starshipit.com/articles/205452843-bigcommerce-product-location.md
Updated: 2026-05-06
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Configure Bin and Warehouse Location fields in BigCommerce to import product attributes into Starshipit.
Starshipit can import orders with product Bin and Warehouse Location from BigCommerce.
In order to have these product attributes show up in Starshipit, you will need to have the following fields configured in your BigCommerce Products.
## To Import Bin Location
1. Go to **Products**.
2. Select a product to edit.
3. Navigate to the **Other Details** tab.
4. Set the **Bin Picking Number**.
## To Import Warehouse Location
1. Go to **Products**.
2. Select a product to edit.
3. Navigate to the **Custom Fields** tab.
4. Create a **Custom Field** with the name **Warehouse**.
5. Enter in the Warehouse value.
---
# BigCommerce: Create a review for Starshipit
URL: https://support.starshipit.com/articles/115000492146-bigcommerce-create-a-review-for-starshipit
Canonical: https://support.starshipit.com/articles/115000492146-bigcommerce-create-a-review-for-starshipit
Markdown: https://support.starshipit.com/articles/115000492146-bigcommerce-create-a-review-for-starshipit.md
Updated: 2026-05-06
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Leave a 5-star review for Starshipit in the BigCommerce app store following these steps.
If you believe our BigCommerce integration is outstanding and you would like to show your appreciation by leaving a 5-star review in the BigCommerce app store, please follow the detailed instructions outlined below. Your positive feedback helps us continue to improve and provide excellent service.
1. Connect to your BigCommerce Management Backend.
2. Go to **Apps** > **My apps** > **Starshipit**.
3. At the bottom of the page click on **Reviews**.
4. Click on **Create Review**.
---
# Connect Brightpearl to Starshipit
URL: https://support.starshipit.com/articles/360000907716-connect-brightpearl-to-starshipit
Canonical: https://support.starshipit.com/articles/360000907716-connect-brightpearl-to-starshipit
Markdown: https://support.starshipit.com/articles/360000907716-connect-brightpearl-to-starshipit.md
Updated: 2026-05-06
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Learn how to integrate with Brightpearl.
Integrate Starshipit with Brightpearl to import Brightpearl orders. Starshipit will write-back tracking information when you print a label.
## 1. Set up web service access in Brightpearl
1. Log into your Brightpearl account.
2. Go to **App Store** > **Private Apps** > **Add private app**.
3. Under **What type of App are you creating?**, select **System app**.
4. Enter a **Name** and **Identifier** of your choice.
5. Click **Install**.
## 2. Add Brightpearl as an integration in Starshipit
1. In your Starshipit account, go to **Settings**, then select **Integrations**.
2. Click **Add a new integration**, and select **Brightpearl**from the list.
3. Select the **Enable Brightpearl**checkbox.
4. Select the server of your store. If you don't know the server, check your Brightpearl website URL.
5. Enter the **Account ID** that you use to log in to Brightpearl.
6. Copy and paste the **Reference** and **Token** from App Store > Private Apps in Brightpearl.
7. Click **Save**.
## 3. Specify status to import
You can specify the status of the order to be imported e.g **Processing**, simply select an option from the drop-down list to change the status.
Alternatively, if you have set up your own workflow and statuses in Brightpearl simply write in your custom status (e.g. 'ready to ship' ) in the status to import field. You can add multiple statuses to import by separating them with a semicolon.
To find a list of the different status names in your Brightpearl account goes to **Settings** > **Sales** > **Sales Statuses**. You can also add a new status on this page.
## 4. Specify status to update
You can also enter the order status that you want your Brightpearl orders to be updated to when write-back occurs from Starshipit. The default status is **Completed,** simply select an option from the drop-down list to change the status. Only one status can be specified for updating orders.
## 5. (Optional) Import and writeback to Goods Out Notes
1. In your [Starshipit](https://app.starshipit.com/Account/MemberLogin.aspx) account, go to **Settings** > **Integrations**.
2. Select **Settings**, next to Brightpearl**.**
3. Tick **Import and writeback to Goods Out Notes.**
4. Click **Save**.
When enabled, Goods Out Notes will be imported allowing you to bring in multiple fulfilments for multi-warehouse and partial shipping.
This useful if an order has items which are out-of-stock or on pre-order, as then that order may have multiple GONs to allow the order to be split fulfilled.
Starshipit will also update each GON individually with the tracking number(s) instead of the overarching sales order, when fulfilling the GON. The updated GONs will be set as Shipped, which also sets the GON as Picked and Packed if not already completed.
## Additional features
#### HS codes and Country of Origin
Starshipit can automatically import these values from Brightpearl. You will need to ensure the attributes are set up as:
* **Country of origin** is read from `PCF_COUNTRYO`
* **HS code** is read from `PCF_HSCODE`
## Configure Brightpearl settings
Complete these settings when you connect Brightpearl. You can return to them later from **Settings > Integrations > Brightpearl**.
| Setting | What it controls |
| --- | --- |
| **Enable Brightpearl** | Turns the connection on or off. |
| **Name** | Gives this Brightpearl connection a recognisable name in Starshipit. |
| **Server** | Selects the Brightpearl server for your account. |
| **Account ID** | Identifies the Brightpearl account used by the connection. |
| **Reference** | The reference from the Brightpearl private app. |
| **Access token** | The access token from the Brightpearl private app. Keep it secret. |
| **Status to import** | Selects the Brightpearl order status or statuses that Starshipit imports. Separate multiple statuses with a semicolon. |
| **Status to update** | Selects the Brightpearl status applied when Starshipit writes back a shipment. This setting is not used when Goods Out Notes are enabled. |
| **Import and writeback to Goods out notes** | Imports and writes back individual Goods Out Notes, which supports partial or multi-warehouse fulfilment. |
Click **Save** after changing settings. Use **Test connection** in the Tools tab to confirm Starshipit can reach Brightpearl.
---
# Connect CartonCloud to Starshipit
URL: https://support.starshipit.com/articles/360000690595-connect-cartoncloud-to-starshipit
Canonical: https://support.starshipit.com/articles/360000690595-connect-cartoncloud-to-starshipit
Markdown: https://support.starshipit.com/articles/360000690595-connect-cartoncloud-to-starshipit.md
Updated: 2026-05-06
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Learn how to integrate with CartonCloud.
Integrate your CartonCloud platform with Starshipit to allow sales orders to be picked up in CartonCloud and automatically transferred to Starshipit.
## About integrating CartonCloud
[CartonCloud](https://help.cartoncloud.com/help/s/article/Starshipit-Integration) is an easy-to-use Transport Management System (TMS) and Warehouse Management System (WMS).
:::note
This integration has been built by CartonCloud. If the information imported into Starshipit is not mapped properly, please contact CartonCloud support.
:::
## Before you begin
* Make sure your Starshipit account is set up with at least one courier account and is on a valid paid or trial plan.
* Connections to Starshipit need to be configured by the CartonCloud team.
## Connect Starshipit with CartonCloud
1. In [Starshipit](https://app.starshipit.com/Account/MemberLogin.aspx), go to **Settings >** **API**.
2. Copy the displayed API key.
If the API key field is blank, click **Regenerate**.
3. Click **Save**.
Keep this page open as you will need to provide the API key to the CartonCloud team.
4. Contact your CartonCloud onboarding consultant or email [CartonCloud support](mailto:support@cartoncloud.com) and provide them with your Starshipit account username and API key.
## FAQs
If CartonCloud is the source, at what point is the order created in Starshipit?
You can configure this using the **Select the Sale Order status** option in CartonCloud to trigger the creation of the shipment in Starshipit. For example, **Packed** or **Dispatched.**
If CartonCloud is the source, how does writeback work for these orders?
CartonCloud will check Starshipit for a tracking number or when CartonCloud prints the label, the tracking number is returned alongside the label to print.
To print labels in the CartonCloud interface without going into the Starshipit app, do I need to use CartonCloud's Transport App?
Not necessarily. It is possible for CartonCloud to add this in as a button in their interface or you can use Starshipit's [Sidekick Chrome extension](/articles/integrations/chrome-extensions/starshipit-sidekick-chrome-extension)!
Will I be required to use Starshipit's Packing Validation?
No, you can continue to pick and pack in CartonCloud.
How are orders assigned to different child accounts?
Orders are pushed to the Starshipit API from the CartonCloud side, use the specific account API key to send orders there.
If I'm printing orders out of CartonCloud, do I need to print using the Starshipit app?
You can choose to print using either the Starshipit app or CartonCloud.
---
# CartonCloud: Troubleshooting
URL: https://support.starshipit.com/articles/360000905035-cartoncloud-troubleshooting
Canonical: https://support.starshipit.com/articles/360000905035-cartoncloud-troubleshooting
Markdown: https://support.starshipit.com/articles/360000905035-cartoncloud-troubleshooting.md
Updated: 2026-05-07
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Learn how to troubleshoot and resolve common issues with the CartonCloud integration.
This article outlines common errors with the Starshipit/CartonCloud integration and how to resolve them. For setup instructions, see [how to integrate with CartonCloud](/articles/integrations/inventory-warehouse-retail-management/how-to-integrate-with-cartoncloud).
## Error: Orders are not importing into Starshipit from CartonCloud
Please check that you do not have any rules blocking orders from being pushed into Starshipit by CartonCloud. To do this:
1. In [Starshipit](https://app2.starshipit.com/), go to **Settings >** **Rules**.
2. Check your rule settings. If everything looks correct, please contact [CartonCloud support](https://www.cartoncloud.com/contact-us).
## Error when printing an order or manifesting orders.
Please contact our support team by submitting a ticket [here.](https://help.starshipit.com)
---
# Connect Catch.com.au to Starshipit
URL: https://support.starshipit.com/articles/4404804129423-connect-catchcomau-to-starshipit
Canonical: https://support.starshipit.com/articles/4404804129423-connect-catchcomau-to-starshipit
Markdown: https://support.starshipit.com/articles/4404804129423-connect-catchcomau-to-starshipit.md
Updated: 2026-05-06
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Step-by-step guide to setting up catch.com.au.
Starshipit integrates with Catch.com.au, an Australian eCommerce sales channel. Please note, at present Catch does not support sending the weight of each item to Starshipit.
## Before you begin
Before you can set up the integration, you'll need the following details from Catch.com.au:
* API Key
* Store URL
* If you have multiple Catch.com.au stores, you'll need your Shop ID and can optionally set your Store Name.
To find your API Key in Catch.com.au:
1. Log into your **Catch.com.au** account > Click on your **email address** in the top right corner (to go to My User Settings).
2. Click the **API Key** tab > click **Copy to clipboard.**
To find your Shop ID in Catch.com.au (only required if you have multiple stores):
1. Log into your **Catch.com.au** account.
2. Copy the **ID** in the top left corner, beside **My Catch Account**.
## Setting up your Catch account in Starshipit
To enable your integration between Starshipit and Catch.com.au, go to:
1. In Starshipit, navigate to **Settings** > **Integrations.**
2. Click **Add a new integration** > **Catch.com.au.**
3. Tick **Enabled.**
4. Enter your **API Key**.
5. (Optional) If you have multiple Catch.com.au stores, enter your **Shop ID.**
6. (Optional) If you have multiple Catch.com.au stores, enter your **Store Name**(i.e. MyShop).
7. Set the required **Order status to import** (by default this is set to SHIPPING).
8. Click **Save**.
Once you've entered and saved these details, click **Test to ensure it works** to verify that your credentials are correct.
## Troubleshooting
While the **Order status to import** in Starshipit needs to be selected as SHIPPING, the matching status in Catch.com.au will be **Shipping In Progress**.
If an order hasn't imported into Starshipit you can check the details for the order by going to **Settings** > **Integrations** > **Catch.com.au** > **Tools** > Enter the order number in the **Check order details** field > Click **Get Order details**.
## Configure Catch settings
| Setting | What it controls |
| --- | --- |
| **Enable Catch.com.au** | Turns the Catch connection on or off. |
| **API key** | Authenticates Starshipit with Catch.com.au. Keep it secret. |
| **Store name** | Identifies the Catch store connected to Starshipit. |
| **Shop ID** | Identifies a specific Catch shop when your account has multiple shops. |
| **Order status to import** | Limits imports to Catch orders with the selected status. The default is `SHIPPING`, which corresponds to **Shipping In Progress** in Catch. |
Click **Save** after changing settings, then use **Test connection** to confirm the connection.
---
# Connect Cin7 Omni to Starshipit
URL: https://support.starshipit.com/articles/360001594575-connect-cin7-omni-to-starshipit
Canonical: https://support.starshipit.com/articles/360001594575-connect-cin7-omni-to-starshipit
Markdown: https://support.starshipit.com/articles/360001594575-connect-cin7-omni-to-starshipit.md
Updated: 2026-05-06
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Integrate your Cin7 Omni platform with Starshipit to import orders and write back tracking information when you print labels.
Integrate your Cin7 Omni platform with Starshipit to import orders and write back tracking information when you print labels.
## 1. Activate Starshipit in Cin7 Omni
1. Ensure the Starshipit module has been installed as per the [Cin7 Omni documentation.](https://help.omni.cin7.com/hc/en-us/articles/9128571486095-Set-up-Starshipit)
2. Log into Cin7 Omni with your admin login.
3. Click on your username in the top right corner of the screen and select the **Settings** option in the drop-down.
4. Click on **Integrations & API**.
5. Select **Starshipit** from the list.
6. Make a note of the **ID** and **Key** as you will need to copy these into Starshipit.
7. Change any other settings as desired then click **Save**.
For more information on each setting please contact [Cin7 Omni support](https://help.omni.cin7.com/hc/en-us/requests/new).
## 2. Set up Cin7 Omni in Starshipit
1. In Starshipit go to **Settings** > **Integrations** > **Add New** > **Cin7 Omni**.
2. Tick **Enable Cin7 Omni** and **Use dedicated API**.
3. Enter your **ID** and **Key** gathered in Step 1 into the **Cin7 Omni ID** and **Cin7 Omni Key** fields respectively.
4. Click **Test to ensure it works**, to check if the connection is successful.
5. Click **Save**.
## 3. Set order statuses for import
You can specify statuses (known as stages in Cin7 Omni) on which Starshipit will import your orders from Cin7 Omni. For example, you can set the app to only import orders which are Processing and/or Fully Picked. You can also specify a custom import status by typing into the drop-down box.
For Starshipit to be able to import orders from Cin7 Omni the below criteria must also be met on each order:
* Sales Orders are **Approved**.
* The fully dispatched field is empty on each Sales Order.
Provided these conditions are met you can import the orders directly into the **New** section of your Starshipit account.
## 4. Importing Dimensions
Starshipit can import item dimensions from the Cin7 Omni setup against your products. To configure dimensions in Cin7 Omni follow [this guide](https://help.omni.cin7.com/hc/en-us/articles/9052674009231-Product-settings).
1. By default, dimensions will be assumed to be in metres. If you are using a different unit of measure in Cin7 Omni, you can configure this from Settings > Integrations > Cin7 Omni settings >
Linear measurement unit to convert from Cin7 Omni
2. Using our Package Setup section you can configure how Starshipit should handle the imported dimensions. For further information, please read [this guide](/articles/orders-manifests-reports/orders/set-up-packages-and-import-weights-and-dimensions).
## Troubleshooting
#### I clicked on test connection and I got an invalid credentials error message
Double-check that you have copied the correct information into Starshipit and that you have saved the information in Cin7 Omni. If this problem persists, contact our [support team](https://help.starshipit.com).
## FAQs
Can I get my rates into my Cin7 Omni portal?
Yes, you can get your Starshipit rates into your Cin7 Omni portal using the Cin7 Omni Rate calculator by following these steps:
1. Log in to Cin7 Omni.
2. From the **Integrations**menu in the navigation, open your Starshipit integration.
3. Open **Settings**.
4. Enter [your Starshipit API key](/articles/integrations/the-starshipit-api/how-to-find-your-starshipit-api-key) into the setting **Starshipit API Key**.
5. Enter [your Starshipit subscription key](/articles/integrations/the-starshipit-api/how-to-find-your-starshipit-api-key) into the setting **Starshipit Subscription Key**.
6. Under **Package Options**, recreate [your Starshipit packages](/articles/orders-manifests-reports/orders/set-up-packages-and-import-weights-and-dimensions) – Omni can’t download your Starshipit package details, so for the rates calculator to work accurately, you must re-define their specifications here.
7. Select **Save**.
Once you’ve configured the rate calculator, use it to see estimated shipping costs for your Starshipit couriers:
1. Log in to Cin7 Omni.
2. From the **Integrations**menu in the navigation, open your Starshipit integration. You’ll see the rate calculator.
3. Enter the package’s destination (**Ship To**) and weight (**Weight**) in kilograms.
4. Select **Get Rates**. You’ll see estimated shipping costs from your couriers under **Shipping Rates Results**.
## Configure Cin7 Omni settings
| Setting | What it controls |
| --- | --- |
| **Enable Cin7 Omni** | Turns the connection on or off. |
| **API version** | Selects **Dedicated API** or **Public API**. The credential fields change with this selection. |
| **API username** and **API connection key** | Authenticate a Public API connection. |
| **ID** and **API key** | Authenticate a Dedicated API connection. |
| **Import stage** | Limits imports to the Cin7 Omni order stage or stages you enter. Separate multiple stages with a semicolon. |
| **Linear measurement unit** | Tells Starshipit whether imported dimensions are in metres (`m`), centimetres (`cm`), or inches (`in`). |
| **Use staging URL** | Uses a Cin7 Omni staging endpoint when the option is available. Use it only with staging credentials. |
| **Map address line 2 to building** | Maps Cin7 Omni address line 2 into Starshipit's Building field. |
Click **Save** after changing settings. Use **Test connection** to verify access, then import a known order and check its stage and dimensions.
---
# Connect Cin7 Core to Starshipit
URL: https://support.starshipit.com/articles/211651203-connect-cin7-core-to-starshipit
Canonical: https://support.starshipit.com/articles/211651203-connect-cin7-core-to-starshipit
Markdown: https://support.starshipit.com/articles/211651203-connect-cin7-core-to-starshipit.md
Updated: 2026-07-30
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Integrate your Cin7 Core platform with Starshipit to import orders and write back tracking information when you print labels.
Connect Cin7 Core and Starshipit to import orders into Starshipit or to request rates and print labels from Cin7 Core. Choose one connection direction based on where your team ships orders.
## Choose your workflow
| Workflow | Configure the connection in | Use when |
| --- | --- | --- |
| Import Cin7 Core orders into Starshipit | Starshipit | Your team manages and ships imported orders in Starshipit. |
| See shipping rates and print labels from Cin7 Core | Cin7 Core | Your team packs and ships sales from Cin7 Core. |
Do not configure both connection directions for the same workflow. The sections below explain the Starshipit-managed import. For the Cin7-managed shipping workflow, see [See shipping rates and shipping method options in Cin7 Core](#see-shipping-rates-and-shipping-method-options-in-cin7-core).
## Before you begin
Before getting started with Cin7 Core you will need a few things.
* Your Cin7 Core Account Id
* Your Cin7 Core API Key
If you do not have the above fields, follow the below steps:
1. Log into Cin7 Core.
2. Go to **Integration** > **Cin7 Core API** **!**
3. Click the + icon to create a new application
4. Ensure you note down the API key that is shown in the prompt
5. On the next screen, ensure you've noted down the Account ID and then click save
## Connect Cin7 Core to Starshipit
### To enable Cin7 Core on your account:
1. Go to **Starshipit** > **Settings** > **Integrations** > **Add a new integration** > **Cin7 Core**
2. Tick the **Enable Cin7 Core** option.
3. Recommended: Select Version 2 for the API version.
4. Enter in the **Account ID** and **Key** from Cin7 Core.
5. Click **Save**.
### Writeback
Starshipit will update your orders with carrier and tracking information when shipped. By default, Starshipit will use "DEFAULT Carrier" when updating your orders in Cin7 Core.
If you wish to have your Cin7 Core orders updated with the specific carrier name then you will need to set up Carrier Mappings in Starshipit.
1. Go to **Settings** > **Integrations** > **Cin7 Core** > **Courier Mappings**.
2. Click **Add a new mapping**.
3. From the courier drop-down, select one of your enabled couriers
4. In the courier name to use textbox, enter in the courier name you have defined in Cin7 Core
5. When done, click the tick icon.
When writeback is attempted for the courier specified, we will send back the courier name you have defined in this field
## See shipping rates and shipping method options in Cin7 Core
Cin7 Core also provides a direct Starshipit shipping-service integration. Use this workflow when your team wants to see shipping rates, choose a shipping method, and print labels from Cin7 Core instead of importing orders for processing in Starshipit.
## Set up checkout rates for Cin7 Core
Cin7 Core's **Get Shipping Rates** action calls Starshipit's Checkout Rates API. Configure Checkout Rates in Starshipit in the same way you would for any other checkout-rates connection. The couriers, shipping options, margins, rules, and package settings you configure there control the rates that Cin7 Core can receive.
1. Follow [Set up rates at checkout](/articles/360000179036-set-up-rates-at-checkout) to configure your package settings and the carrier services you want to return.
2. Add any margins, table rates, or [checkout-rate rules](/articles/rates-at-checkout/set-up-guides/rules-for-checkout-rates) that should apply to Cin7 Core rate requests.
3. Go to **Settings > Checkout Rates > Tools**, select **API**, and test with the same destination and shipment weight you plan to quote in Cin7 Core.
The rates returned by the test tool should match the services Cin7 Core can request when it sends the same shipment details.
Before requesting rates:
* Connect Starshipit from **Integrations > Starshipit** in Cin7 Core using a Starshipit API key.
* Make sure the currency and measurement units in Cin7 Core match your Starshipit account settings.
* Add valid addresses to the Cin7 Core locations you ship from.
* Add accurate weights and dimensions to products in Cin7 Core.
* Complete the Checkout Rates setup above and enable every service you want Cin7 Core to return.
:::important
The **Courier Mappings** under Starshipit's Cin7 Core integration control carrier names written back when Starshipit imports and ships an order. They do not make services available to Cin7 Core's **Get Shipping Rates** action. Enable those services under **Settings > Checkout Rates** instead.
:::
To see shipping rates and shipping method options in Cin7 Core:
1. Open a Simple Sale or Advanced Sale at the Quote or Order stage.
2. Add products with accurate weights and dimensions.
3. Click **Get Shipping Rates**.
4. Select **Starshipit**.
5. Select a returned carrier and service, then confirm the rate.
Cin7 Core displays the available carrier and service choices returned by Starshipit as shipping method options. It only returns options configured in Starshipit Checkout Rates. A separate "cheapest carrier" rule is not required to compare those returned rates. If Cin7 Core passes a carrier value that must select a specific Starshipit service for label creation, configure a Starshipit rule using the **Shipping Method** condition.
For the complete Cin7-side setup and label workflow, see [Cin7 Core's Starshipit integration guide](https://help.core.cin7.com/hc/en-us/articles/9034616030095-Starshipit-Integration).
## Additional Configuration
**Status to import**: Use this option to specify what status orders should be in to import into Starshipit. You can specify multiple by separating each status with a semi-colon. For example: Ordering;Picked
**Advanced Sales**: If you are using Cin7 Core [Advanced Sales - Multiple Fulfillments](https://help.core.cin7.com/hc/en-us/articles/9034450166287-Advanced-Sales-Multiple-Fulfillment) you can configure your Starshipit integration to import each fulfilment and a single order, instead of importing the overall sales orders.
To do this, you will need to be on Cin7 Core Version 2 and select "Import Sale Fulfillments instead of Sales". This means you will have multiple Starshipit orders for the one order in Cin7 Core allowing you to ship them separately with ease.
**Import Memo/Order Notes**: By default, Starshipit does not import memos from Cin7 Core. If you would like these to import into the delivery instructions field, select the option you would like from the memo drop-down. Alternatively, you can import the order notes by selecting **Import order note into delivery instructions**
**Import additional product information**: Turn on **Import additional product information** to import product details, including barcodes, from Cin7 Core. This lets Packing Validation match a scanned product barcode to an imported order item.
**API Limits**: Cin7 Core has an API limit of 60 calls per 60 seconds. This can occasionally mean that the writeback to Cin7 Core will fail, or that the import will fail. These both will retry again should they fail.
**Use contact field as company name**: By default, Starshipit will use Customer as the contact name, however, you can use this option to use the sale.ShippingAddress.Contact field for the Starshipit receiver address company field instead.
---
# Connect legacy Cin7 to Starshipit
URL: https://support.starshipit.com/articles/217503906-connect-legacy-cin7-to-starshipit
Canonical: https://support.starshipit.com/articles/217503906-connect-legacy-cin7-to-starshipit
Markdown: https://support.starshipit.com/articles/217503906-connect-legacy-cin7-to-starshipit.md
Updated: 2026-05-06
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Integrate your Cin7 platform with Starshipit using the legacy integration. The latest integration using a dedicated API is recommended.
Integrate your Cin7 platform with Starshipit using the legacy Cin7 integration. It is recommended you use the latest integration which uses a dedicated API by following the instructions for [Cin7 Omni](/articles/integrations/inventory-warehouse-retail-management/cin7-omni-integration). Once completed, your orders can be imported into Starshipit and the tracking information will be written back when you print labels.
## 1. Add API connection in Cin7
1. Log into Cin7 and click the Settings cogwheel from the bottom left of the app.
2. Click **Integrations**, then select **API v1**.
3. Copy and note your API username displayed at the top of the page.
4. Click **Add API Connection**.
5. Enter a name for the integration that makes sense to you (e.g. Starshipit), then click **Save**.
6. Copy and note your API key.
7. Under **API Connections** select **Permissions**.
8. Add Create, Read, Update permissions to Sales Orders, Products and Product Options then click **Save**.
## 2. Copy the information into Starshipit
1. In [Starshipit](https://app2.starshipit.com/) go to **Settings** > **Integration** > **Add New** > **Cin7**.
2. Tick **Enable Cin7** and **Use Public API**.
3. Complete Cin7 Username and Cin7 Key with the information gathered in Step 1.
4. Test the connection to ensure it's working.
5. Click **Save**.
## 3. Set order statuses for import
You can specify statuses on which Starshipit will import your orders from Cin7. For example, you can set the app to only import orders which are Processing and/or Fully Picked.
## Troubleshooting
#### Error: I clicked on test connection and I got an invalid credentials error message
Double-check that you have copied the correct information into Starshipit, and that you have saved the information in Cin7. If this problem persists, contact our support team [here](https://help.starshipit.com).
---
# Connect eBay to Starshipit
URL: https://support.starshipit.com/articles/204502835-connect-ebay-to-starshipit
Canonical: https://support.starshipit.com/articles/204502835-connect-ebay-to-starshipit
Markdown: https://support.starshipit.com/articles/204502835-connect-ebay-to-starshipit.md
Updated: 2026-05-06
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Learn how to integrate Starshipit with eBay so your orders import directly from eBay.
## Integrate eBay
1. Close all browsers that you have open for eBay, this will ensure the link between Starshipit & eBay is set up correctly. This is especially important if you are adding multiple eBay stores.
2. In [Starshipit](https://app2.starshipit.com/), navigate to **Settings** > **Integration**
3. Click on **Add a new integration** and select eBay from the list.
4. Click on **Authorize**. You will be directed to the eBay login page.
5. Log in with your eBay credentials.
6. Click **Authorise**, and you will be redirected to Starshipit.
7. You have now completed the eBay integration.
## Troubleshooting
#### **I don't have a .com.au eBay account.**
You can select the country of origin of your eBay account. Go to **Advanced Settings** and select your country.
#### **The item descriptions are not coming through properly in Starshipit**
Starshipit will import the eBay Item Description, but if you are not using it you can use the Title instead. To do this go to **Advanced settings**, tick **Use the title for product description,** otherwise it will default to the description column.
## Configure eBay settings
During setup, authorise eBay, complete these settings, then save the connection. You can update them later from the eBay integration settings:
| Setting | What it controls |
| --- | --- |
| **Enable eBay** | Turns the eBay connection on or off. |
| **Name** | Identifies the eBay store in Starshipit. |
| **Session** | Stores the eBay authorisation session created during connection. You normally do not enter this manually. |
| **Token** | Stores the eBay authorisation token. You normally do not enter this manually. |
| **Status to import** | Limits imports to the eBay order statuses you enter. Separate multiple statuses with a semicolon. |
| **Status to set** | Sets the eBay order status when Starshipit writes back a shipment. |
| **Target site** | Selects the eBay site associated with this store, such as Australia or the United States. |
| **Use the title** | Uses the eBay item title as the product description instead of the item description. |
| **Update status for check** | Updates the eBay status when you use the order-check workflow. |
| **Import buyer checkout message** | Includes the buyer's checkout message in the imported order. |
| **Import buyer username as reference** | Uses the buyer's eBay username as the Starshipit order reference. |
| **Generate unique tracking number on writeback** | Creates a unique tracking number for Plain Label and Pickup In Store shipments when the tracking number is blank. |
Click **Save** after changing settings, then click **Test connection** to verify the connection.
---
# Connect Ecwid to Starshipit
URL: https://support.starshipit.com/articles/11425795615631-connect-ecwid-to-starshipit
Canonical: https://support.starshipit.com/articles/11425795615631-connect-ecwid-to-starshipit
Markdown: https://support.starshipit.com/articles/11425795615631-connect-ecwid-to-starshipit.md
Updated: 2026-05-06
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Learn how to integrate Starshipit with Ecwid so your orders import directly from Ecwid.
## How to set up Ecwid
Save time and manual data entry by importing orders directly into Starshipit. Once the orders are fulfilled, Starshipit will send the tracking data back to Ecwid and update the status of the order, saving you clicks per day.
#### 1. Ecwid setup
1. In Ecwid, navigate to **Apps** > **My Apps**.
2. Create a new app. Give it a convenient name like 'Starshipit'.
3. Under **App Access Tokens**, take note of the **secret token**. Save this for later.
#### 2. Set up Ecwid
1. In Starshipit, navigate to **Settings** > **Integrations**.
2. Select **Add a new integration**.
3. Select **Ecwid** from the list of eCommerce Platforms.
4. Tick the **Enabled** checkbox.
5. Enter your **API Key** (secret token from the previous step) and **Store ID** (can be found in the URL when you access ecwid - i.e. [https://my.ecwid.com/store/12345678](https://my.ecwid.com/store/107508101) so 12345678)
6. Click **Save**.
#### 3. Set the order status to import
1. From the Integrations page, select **Settings** next to **Ecwid**.
2. Under the **Status to import** dropdown menu, select which status you'd like imported. Multiple options can be selected.
3. Click **Save**.
#### 4. Set orders to import automatically
You can set Starshipit to import new orders from Ecwid every 20 minutes automatically.
1. From the Integrations page, click the checkbox next to **Automatically import orders from all integrations (typically every 20 minutes)**.
2. When you've sent out your orders, Starshipit will write-back tracking details to Ecwid and mark your orders as fulfilled.
## Configure Ecwid settings
| Setting | What it controls |
| --- | --- |
| **Enable Ecwid** | Turns the Ecwid connection on or off. |
| **Store ID** | Identifies the Ecwid store. It is the number in your Ecwid store URL. |
| **API key** | Authenticates Starshipit with Ecwid. Keep the secret token secure. |
| **Fulfilment status to import** | Selects the Ecwid fulfilment statuses that Starshipit imports. Multiple statuses can be selected. |
Click **Save** after changing settings, then use **Test connection** to verify the connection.
---
# Connect Etsy to Starshipit
URL: https://support.starshipit.com/articles/206090525-connect-etsy-to-starshipit
Canonical: https://support.starshipit.com/articles/206090525-connect-etsy-to-starshipit
Markdown: https://support.starshipit.com/articles/206090525-connect-etsy-to-starshipit.md
Updated: 2026-05-06
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Learn how to integrate your Etsy platform to Starshipit.
## Integrate your Etsy account
1. In Starshipit, navigate to **Settings** > **Integrations**.
2. Click **Add a new integration** > **Etsy**.
3. Tick **Enable Etsy**.
4. Click **Authorize**. This will redirect you to your Etsy account.
5. Click on **Allow Access**. This will redirect you back to Starshipit.
6. Enter your Etsy shop name.
7. Click **Save**.
8. Click **Test to ensure it works** to validate that your integration is working.
## Troubleshooting
**How do I turn off Customer Notifications on Etsy?**
Click on your shop icon and then shipping labels. Scroll to the bottom on the right and make sure the notification box is unchecked.
**I get an "Invalid Shop Name" error when I test the connection**
Make sure you have added an About section to your Etsy profile.
## Configure Etsy settings
| Setting | What it controls |
| --- | --- |
| **Enable Etsy** | Turns the Etsy connection on or off. |
| **Shop name** | Identifies the Etsy shop that Starshipit imports orders from. |
| **OAuth access token** | The access credential created by Etsy authorisation. You normally do not need to enter it manually. |
| **OAuth refresh token** | Allows Starshipit to refresh access after the initial Etsy authorisation. You normally do not need to enter it manually. |
| **Import paid receipts** | Imports paid and unshipped receipts only when enabled. When disabled, all unshipped receipts are imported. |
| **Map address line 2 to building** | Maps Etsy address line 2 into Starshipit's Building field; otherwise it is mapped to the Suburb field. |
Click **Save** after changing a setting, then use **Test connection** to verify the connection.
---
# Connect Extensiv (Formerly 3PL Central) to Starshipit
URL: https://support.starshipit.com/articles/360000117075-connect-extensiv-formerly-3pl-central-to-starshipit
Canonical: https://support.starshipit.com/articles/360000117075-connect-extensiv-formerly-3pl-central-to-starshipit
Markdown: https://support.starshipit.com/articles/360000117075-connect-extensiv-formerly-3pl-central-to-starshipit.md
Updated: 2026-09-03
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Learn how to integrate with Extensiv (formerly 3pl central).
Extensiv provides one of the most popular cloud-based WMS solutions available in the third-party logistics and warehousing industry. Integrate Starshipit with Extensiv to import orders and writeback tracking information when you print labels.
## How the integration works
Extensiv is compartmentalised per customer, meaning that, in addition to creating an overall parent account in Starshipit, you need to create child accounts for each of your customers. To do this, you need the Customer ID to specify which customer's orders you would like imported into Starshipit.
## 1. Request your REST API keys
To access the REST API Credentials page, your Extensiv subscription must include an **API package** and your user account must be designated as the **super user** of the Support Portal. If you need assistance and would like to learn more about this, please reach out to your Extensiv account manager.
Your account manager should be able to provide you with the following information:
* 3PL GUID
* User ID
* Password
Please refer to the chart below to find the correct information.
| Starshipit | Extensiv |
| --- | --- |
| 3PL GUID | 3PL Key |
| User ID | Client ID |
| Password | Client Secret |
| Customer ID | Customer ID in Extensiv |
## 2. Determine the customer ID for each customer
In Extensiv, using the admin login, retrieve the customer ID from the settings. If you are unsure of how to do this, reach out to your Extensiv account manager.
## 3. Enter Your API key details and the customer ID in Starshipit
Log into Starshipit and override the child account that you want to set up:
* In your Starshipit account, go to **Settings >** **Integrations**.
* Click **Add a new integration**, then select Extensiv from the list.
* Turn on **Enable Extensiv (3PL Central)**.
* Complete **Extensiv GUID**, **User ID**, and **Password** with the information provided by your account manager.
* Complete **Customer ID(s)** with the customer IDs whose orders this Starshipit account should import. Enter more than one ID only when this account should process orders for more than one Extensiv customer.
* Enter the **Facility ID** when you use the export-to-Extensiv workflow described below. It identifies the Extensiv facility that receives the order.
* Click **Save**.
## Check the connection
Select **Test connection** after saving. A successful test confirms that the Extensiv credentials and customer scope can be reached before you start importing orders.
## 4. Additional settings
#### Export orders to Extensiv on import from another integration
This option will set Starshipit to export orders from your other integrations directly into Extensiv, instead of orders being imported from Extensiv. When you process an order in Starshipit from one of the other integrations (e.g. Shopify), we will update both Extensiv and the other integration.
When enabling this option you must also fill in the **Facility ID** in the Extensiv settings page in Starshipit. You can get this from within Extensiv.
There is also an additional function to push manual orders across to Extensiv, accessed from the Extensiv settings page's Tools tab. Simply enter one or more order numbers (semicolon-separated) in the **Export orders to Extensiv** field, and click **Export**.
#### Import only orders that have stock
Extensiv can flag the orders that have available stock to be fulfilled. To import only these orders in Starshipit, you can tick the option **Import orders that have stock (Fully allocated)**.
After ticking the option, remove and re-import your orders.
#### Import 3PL order # as order # (our ref) + 3PL ref # as ref # (their ref)
When ticked, Starshipit will reverse the order number, and reference mapping to instead import the fields as follows:
Order ID (Extensiv) -> Order Number (Starshipit)
Reference Number (Extensiv) -> Reference (Starshipit)
#### Recalculate charges on writeback
This option triggers Extensiv to recalculate Auto Charges during writeback by including the necessary field in the API request. Enable this setting in the Extensiv settings page in Starshipit to ensure charges are updated correctly.
#### QuickBooks integration enabled
If your Extensiv account is integrated with QuickBooks, enable this option to include additional invoice information during writeback. This ensures compatibility with QuickBooks-enabled accounts. If your account does not use QuickBooks, leave this option disabled to avoid API call failures.
#### Bin locations, HS codes, and country of origin
Starshipit imports bin location, HS code, and country of origin data from Extensiv where those fields are populated.
- **Bin locations** are included on import and can assist with picking workflows.
- **HS codes** and **country of origin** are imported and applied to the order for use in customs documentation on international shipments.
To use these fields, make sure bin locations, HS codes, and country of origin are populated against the relevant items in Extensiv. No additional setup is required in Starshipit.
---
# Connect KatanaMRP to Starshipit
URL: https://support.starshipit.com/articles/11744970033807-connect-katanamrp-to-starshipit
Canonical: https://support.starshipit.com/articles/11744970033807-connect-katanamrp-to-starshipit
Markdown: https://support.starshipit.com/articles/11744970033807-connect-katanamrp-to-starshipit.md
Updated: 2026-05-06
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Learn how to integrate with KatanaMRP.
Integrate Starshipit with KatanaMRP to import orders directly. Once orders are fulfilled, Starshipit will send the tracking data back to KatanaMRP and update the order status.
## How it works
#### 1. Set up KatanaMRP
1. In Starshipit, navigate to **Settings** > **Integrations**.
2. Select **Add a new integration**.
3. Select **KatanaMRP** from the list of Inventory Management Platforms.
4. Tick the **Enabled** checkbox.
5. Click the **Authorize** button.
This will open a new window for you to log into your KatanaMRP account and give Starshipit permission to access your order data.
6. On the KatanaMRP login pop-up, sign in.
7. You will then be redirected back to Starshipit.
#### 2. Set the order status to import
1. From the Integrations page, select **Settings** next to **KatanaMRP**.
2. Under the Status to import dropdown menu, select which status you'd like imported. Multiple options can be selected.
3. Click **Save**.
#### 3. Set orders to import automatically
You can set Starshipit to automatically import new orders from KatanaMRP every 20 minutes.
1. From the Integrations page, click the checkbox next to **Automatically import orders from all integrations (typically every 20 minutes)**.
2. When you've sent out your orders, Starshipit will write back tracking details to KatanaMRP and mark your orders as fulfilled.
**!**
## Configure KatanaMRP settings
| Setting | What it controls |
| --- | --- |
| **Enabled** | Turns the KatanaMRP connection on or off. |
| **Authorise** | Opens Katana so you can grant Starshipit access. The connection status below the button shows whether authorisation is active. |
| **Statuses to import** | Selects the Katana order statuses that Starshipit imports. Separate multiple statuses with a semicolon. |
Click **Save** after changing the import statuses. Use **Authorise** again if the connection status shows **Not connected**.
---
# Connect Klaviyo to Starshipit
URL: https://support.starshipit.com/articles/7818536390799-connect-klaviyo-to-starshipit
Canonical: https://support.starshipit.com/articles/7818536390799-connect-klaviyo-to-starshipit
Markdown: https://support.starshipit.com/articles/7818536390799-connect-klaviyo-to-starshipit.md
Updated: 2026-04-02
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Step-by-step guide to setting up Klaviyo.
Our integration with Klaviyo enables you to sync shipping events and status updates with your Klaviyo account. You can use these as part of your Klaviyo email flows and to personalise emails.
{{video:youtube:Rqr1\_l1kqvs}}
## Set up Klaviyo in Starshipit
1. In Starshipit, navigate to **Settings** \> **Tracking and notifications**.
2. Scroll down to **Set up Klaviyo**.
3. Tick the checkbox next to **Enable Klaviyo**.
4. Click **Connect with Klaviyo**.
## How to create an email notification flow in Klaviyo
1. Sign in to Klaviyo.
2. Navigate to **Flows**.
3. Click **Create Flow**.
4. Click **Create from scratch**.
5. Enter a name for the flow and click **Create Flow**.
6. To set the notification trigger, select **Metric**.
7. From the dropdown menu, select **Starshipit Tracking status**.If you don't see this option, [read this](#h_01HTKBQACG0XSP7Z900S8WJ07F) troubleshooting step.
8. Click **Done**.
9. Drag and drop the **Email** option into the flow.
10. To make edits, click on **...** and then select **Edit** within the email action.
11. To customise your email content, you can use the following dynamic variables:\
**Order Number \-\> \{\{ event\.orderNumber\|default:'' \}\}**
**Carrier \-\> \{\{ event\.carrier\|default:'' \}\}**
**Tracking Status \-\> \{\{ event\.trackingStatus\|default:'' \}\}**
**Tracking Number \-\> \{\{ event\.trackingNumber\|default:'' \}\}**
**Tracking URL \-\> \{\{ event\.trackingUrl\|default:'' \}\}**
**New Branded Tracking Page URL \-\> "https://app\.starshipit\.com/BrandedTrack\.aspx?code=\{\{ event\.trackingNumber\|default:'' \}\}"**
**Classic Tracking Page URL \-\> "https://app\.starshipit\.com/track\.aspx?code=\{\{ event\.trackingNumber\|default:'' \}\}"**
12. Click on **Review and Turn On** to activate the notification.
13. Click **Exit** when you've finished.
## How to trigger different emails based on tracking status
1. Sign in to Klaviyo.
2. Navigate to **Flows.**
3. In the **Logic** section, choose **Trigger Split** and drag it beneath the trigger action.
4. In the Configuration settings, click on **Dimension**.
5. Click **trackingStatus.**
6. Input the tracking status and the condition that should prompt the notification.
7. Repeat the process of adding a trigger split for each tracking status that requires a notification.
## FAQs
How soon does Starshipit transmit tracking updates to Klaviyo?
Starshipit sends tracking updates to Klaviyo instantly once it receives updated information from the supported carrier.
Which events trigger updates in Starshipit for Klaviyo?
Starshipit triggers Klaviyo updates during the following stages:
* Printed
* Dispatched
* In Transit
* Out for Delivery
* Delivered
Do I need to have a customer profile in Klaviyo before I receive tracking updates from Starshipit?
Yes. If you don't have a profile, Klaviyo will automatically create a user profile when an update is pushed through. However, this automatic profile will be treated as a non-subscriber, meaning they won't receive any notifications.
## Troubleshooting
#### Why is 'Starshipit Tracking Status' not showing in my Klaviyo drop-down menu?
'Starshipit Tracking Status' will appear in your Klaviyo metric dropdown after the first event update from Starshipit to Klaviyo. To trigger this update, initiate the shipment of an order (e.g., print the shipping label) and the Starshipit Tracking Status should show in the metric dropdown. If you still encounter issues, contact our support team [here](https://help.starshipit.com) for assistance.
**What tracking information does Starshipit send to Klaviyo?**
Starshipit transmits the following details:
* Tracking Status
* Order Number
* Carrier
* Tracking Number
* Tracking URL
#### My customers aren't receiving emails. What could be causing this?
Several factors could cause this situation:
* Your Klaviyo connection may be invalid or expired. Reconnect Klaviyo from Starshipit settings.
* The customer's profile might not be subscribed to emails.
* Smart sending could be enabled. You can find more details in the [Klaviyo Help Center](https://help.klaviyo.com/hc/en-us/articles/115002779311).
---
# Connect Lightspeed to Starshipit
URL: https://support.starshipit.com/articles/202605060001-connect-lightspeed-to-starshipit
Canonical: https://support.starshipit.com/articles/202605060001-connect-lightspeed-to-starshipit
Markdown: https://support.starshipit.com/articles/202605060001-connect-lightspeed-to-starshipit.md
Updated: 2026-05-06
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Learn how to integrate Starshipit with Lightspeed so your sales import directly into Starshipit.
Integrate Starshipit with Lightspeed to import your Lightspeed sales into Starshipit. After you print a label, Starshipit can mark the sale as fulfilled in Lightspeed.
## What you need to get started
Before you get started, make sure you have:
* A Lightspeed Retail X-Series account.
* Access to your Starshipit account settings.
* Your Lightspeed domain prefix.
* A Lightspeed personal token, if you are connecting with a token instead of OAuth.
Your domain prefix is usually the first part of your Lightspeed store address. Do not include `https://` or the full website address.
## How to set up Lightspeed
You can connect Lightspeed using OAuth or your domain prefix and personal token.
1. In Starshipit, go to **Settings > Integrations**.
2. Select **Add a new integration**.
3. Select **Lightspeed**.
4. Tick **Enable Lightspeed**.
5. Enter your Lightspeed domain prefix.
6. Choose one connection option:
* Click **Authorize OAuth** and follow the prompts.
* Enter your Lightspeed personal token.
7. Review your import filters.
8. Tick **Write back dispatches to Lightspeed** if you want Starshipit to update fulfilled sales in Lightspeed.
9. Click **Test connection**.
10. Click **Save**.
## Create a Lightspeed personal token
Lightspeed personal tokens are only available on some Lightspeed Retail X-Series plans.
If you need to use a personal token:
1. In Lightspeed Retail POS, go to **Setup > Personal tokens**.
2. Click **Add Personal token**.
3. Enter a token name.
4. Click **Generate personal token**.
5. Copy the token and store it somewhere safe.
You will not be able to view the token again after you close the popup.
:::note
Lightspeed does not support tracking number updates for this integration. Starshipit will mark the sale as fulfilled, but the tracking number will not be sent back to Lightspeed.
:::
## Configure Lightspeed settings
| Setting | What it controls |
| --- | --- |
| **Enable Lightspeed** | Turns the Lightspeed connection on or off. |
| **Domain prefix** | Identifies your Lightspeed Retail X-Series account. Enter the part before `.retail.lightspeed.app`, without `https://`. |
| **Personal token** | An optional alternative to OAuth for authenticating the connection. |
| **State filter** | Imports only delivery sales with the state you specify. |
| **Attribute filter** | Imports only delivery sales with the attribute you specify. |
| **Legacy status filter** | Provides status matching for older Lightspeed order data. |
| **Outlet IDs** | Limits imports to specific outlets. Enter comma-separated outlet IDs. |
| **Write back dispatches to Lightspeed** | Sends dispatch details back to Lightspeed after labels are created. |
Click **Save** after changing settings. Use **Test connection** to verify the connection and review the import filters if expected sales do not appear.
---
# Connect Locate2u to Starshipit
URL: https://support.starshipit.com/articles/9983708826255-connect-locate2u-to-starshipit
Canonical: https://support.starshipit.com/articles/9983708826255-connect-locate2u-to-starshipit
Markdown: https://support.starshipit.com/articles/9983708826255-connect-locate2u-to-starshipit.md
Updated: 2026-05-06
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Learn how to integrate with Locate2u.
## Before you begin
Before setting up Locate2u, you will need your Locate2u client credentials which you can find [here](https://developer.locate2u.com/generate-api-keys/).
## Set up Locate2u in Starshipit
1. Navigate to **Settings** > **Couriers > Add a new courier > Locate2U**
2. Select **Enable**
Locate2U must be linked to a plain label courier. After enabling Locate2U, make sure it’s linked to a plain label option.
1. Go to **Settings > Couriers**, find the plain label option you want to use with Locate2U and click **Settings**. If you don’t have one, add a new courier and select **Plain Label**.
2. Open the **Locate2U** tab (this only appears after Locate2U has been enabled).
3. Enter your Locate2u Client ID and Client Secret.
4. Click **Save**.
## FAQs
When does Starshipit send delivery updates to Locate2u?
Starshipit sends delivery details (stops) when the label is printed.
I have multiple vehicles which I have set up as separate plain labels. Can I connect both of these with Locate2u?
Yes, you can send deliveries from both plain labels to Locate2u. If you have one Locate2u account for both, you'll add the same client credentials to both plain label settings. If you have separate Locate2u accounts, you'll add the appropriate credentials to the respective plain label settings.
If connected with Locate2u, which tracking details will my customers receive?
When Locate2u is enabled, your customers will receive tracking details from Locate2u.
What delivery events trigger notifications?
We trigger customer notifications for the following statuses:
* Printed
* In Transit
* Out for Delivery
* Delivered
When we enable Locate2u, do we need to update any current settings, such as the tracking URL?
No, there is no need to update your current settings. The system will automatically handle this. You can leave your settings as they are.
Can we book return shipments with Locate2u?
Currently, this is not supported for return shipments of outbound orders. If you need this feature, please reach out to us via Canny or contact our support team.
Do you send delivery instructions (such as Signature Required and ATL) to Locate2u?
No, we only create stops in Locate2u. Any delivery instructions need to be included on the label or via the Locate2u platform.
Why does Locate2U need to be linked to a plain label courier?
Locate2U doesn’t provide its own shipping labels. By linking it to a plain label courier in Starshipit, you can generate a custom label for these orders, load in your own rates, and print orders as usual. The plain label option acts as the label-generation layer for your Locate2U jobs.
What happens if you're unable to create stops in Locate2u?
If there is an error while creating a stop in Locate2u, an error message will be displayed and the label will not be printed.
Can we create stops for future dates?
No, this is not currently supported. We send the print date (AU time) as the TripDate.
Our vehicles have a maximum capacity. How will we know when we have reached the capacity for the vehicle?
Currently, we don’t receive any information regarding maximum capacity back from Locate2u. This needs to be managed through the Locate2u platform.
There will be occasions when we can’t fulfill a delivery through our own network. When this happens, we want to reallocate it back to a standard carrier. Should we just redo the order with the new carrier?
Yes, this is possible but not recommended. This is because when the original order is printed, the customer receives a notification with Locate2u tracking details. Redoing the shipment with an alternative carrier may cause confusion for your customer. We recommend allocating deliveries to your own network only when you are certain you can fulfil them through your delivery network.
---
# Connect Magento 1 to Starshipit
URL: https://support.starshipit.com/articles/203826179-connect-magento-1-to-starshipit
Canonical: https://support.starshipit.com/articles/203826179-connect-magento-1-to-starshipit
Markdown: https://support.starshipit.com/articles/203826179-connect-magento-1-to-starshipit.md
Updated: 2026-05-06
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Learn how to integrate your Magento 1 platform with Starshipit.
## Before you begin
You can have more than one Magento store integrated with Starshipit if the stores are under the same Magento account in the Admin panel. If they are in separate Magento accounts, you'll need to set it up as a child account.
## 1. Create a role and user in Magento 1
Set up an API access, and create a Webservice role and assign it to a Webservice role in Magento.
#### Create a new role
1. Go to your Magento Admin Dashboard.
2. From the **System** menu, select **Web Services**, then select **SOAP/XML-RPC - Roles**.
3. From the roles page, click **Add New Role**.
4. Enter a role name, and then click **Role Resources**.
5. Set the **Resource Access** to **ALL**.
6. In the top right-hand of the screen, click **Save Role**.
#### Assign your new role to a user
1. Go to your Magento Admin Dashboard.
2. From the **System** menu, select **Web Services**, then select **SOAP/XML-RPC - User**.
3. From the users page, click **Add new User**.
4. Enter the account information as required.
Note that the API Key will work as the password you enter in Starshipit. You can set this accordingly.
5. Set the account to **Active**.
6. On the **User Information** panel, click **User Role**. Assign the user your previously created the role for.
## 2. Enter your Magento 1 details in Starshipit
After you have created the user and the role in Magento, you need to add the URL, username and the password in Starshipit. You can customise the status of orders to import, however the default status "processing" should be correct for most Magento stores.
1. In Starshipit, navigate to **Settings** > **Integrations**.
2. Click **Add a new integration** and select **Magento**.
3. Enter the URL of your site e.g. http://www.mysite.com/api/xmlrpc or http://www.mysite.com/index.php/api/xmlrpc.
4. Enter your Magento username and password. The password is the API Key that you created in Magento.
5. Click **Save**, then test your connection using the **Test to ensure it works** button.
## (Optional) Disable email notifications in Magento
1. Log in to your Magento account.
2. From the **System** menu, select **Configuration**.
3. Under the **Advanced** tab, select the **System** menu item.
4. Select **Mail Sending Settings**.
5. Set **Disable Email Communications** to ‘**Yes**’.
Emails will no longer be sent through Magento.
## Delivery instructions
The following fields are imported for Delivery Instructions:
* myOrderInfo.shipping_address.special_delivery_info
* myOrderInfo.special_delivery_info
* myOrderInfo.shipping_address.customer_comments
* myOrderInfo.customer_note
* myOrderInfo.onestepcheckout_customercomment
## Configure Magento 1 settings
Complete these connection and import controls during setup. You can update them later from **Settings > Integrations > Magento 1**:
| Setting | What it controls |
| --- | --- |
| **Enable Magento1** | Turns the Magento 1 connection on or off. |
| **URL** | The Magento API endpoint, usually ending in `/api/xmlrpc` or `/index.php/api/xmlrpc`. |
| **User Name** | The Magento web-service user name. |
| **API Key** | The API key/password for the Magento web-service user. |
| **Network User Name** | Optional network-level authentication user name when your Magento host requires it. |
| **Network API Key** | Optional network-level authentication key. |
| **User Agent** | Optional value sent to Magento to identify Starshipit requests. |
| **Import Hours** | Limits the age of orders considered during an import. |
| **Import Status** | Limits imports to orders with the status you enter. |
| **Sync complete and cancelled** | Includes complete and cancelled Magento orders in synchronisation. |
| **Import on search** | Allows a search to retrieve an order from Magento when it is not already imported. |
| **Enable writeback** | Sends tracking and shipment updates back to Magento. |
Click **Save** after changing settings, then use **Test connection** to verify the connection.
---
# Magento 1: Troubleshooting
URL: https://support.starshipit.com/articles/360000908816-magento-1-troubleshooting
Canonical: https://support.starshipit.com/articles/360000908816-magento-1-troubleshooting
Markdown: https://support.starshipit.com/articles/360000908816-magento-1-troubleshooting.md
Updated: 2026-02-12
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Learn how to troubleshoot and resolve common issues with the Magento 1 integration.
This article explains how to resolve common errors with the Magento 1 integration. For setup instructions, see [how to integrate with Magento 1](/articles/integrations/ecommerce-platforms/how-to-integrate-with-magento-1).
## Errors when testing your connection
### Error: Not found
Check that you have entered the correct email address.
### Error: Server returned a fault exception: [2] Access denied
Check that you have entered the correct username and password.
## Issues with your account integration
### Your Magento account isn't syncing with Starshipit
1. In Starshipit, navigate to **Settings** > **Integrations** > **Magento Settings**.
2. Under **Writeback settings**, ensure **Enable writeback of tracking number and update status** is checked.
### Account set up is unsuccessful
To check whether an account was correctly set up:
1. Copy the URL and paste it in the browser search bar.
* If an error is returned, there is an issue with the URL.
* If you are directed to a page with a small script, then the URL is correct. If the URL is correct, the error is at the authentication level.
2. Check that the username and password is correct.
3. Ask the client for the role name, and compare the details entered to those supplied by the client.
## Importing issue for Magento version 1.9.3
If you are using Magento version 1.9.3 and sales order items are not being returned via the Magento API, you can use this workaround:
1. Edit file: `app/code/core/Mage/Api/Model/Server/Handler/Abstract.php`
2. Find line: `if (!is_null($row) && !is_bool($row) && !is_numeric($row)) {`
3. Replace with: `if (!is_null($row) && !is_bool($row) && !is_numeric($row) && !is_array($row)) {`
---
# Connect Maropost to Starshipit
URL: https://support.starshipit.com/articles/212085063-connect-maropost-to-starshipit
Canonical: https://support.starshipit.com/articles/212085063-connect-maropost-to-starshipit
Markdown: https://support.starshipit.com/articles/212085063-connect-maropost-to-starshipit.md
Updated: 2026-08-26
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Integrate your Maropost (formerly Neto) platform with Starshipit to import orders and write back tracking information when printing labels.
Integrate your Maropost (formerly Neto) platform with Starshipit to import orders and write back tracking information when you print labels.
## 1. Create an API user in Maropost
1. Log into your Maropost Control Panel
* If your site is not live, go to your Maropost provided URL - yourdomain.neto.com.au/_cpanel
* If your site is live, go to your domain URL - [www.yourdomain.com.au/_cpanel](http://www.yourdomain.com.au/_cpanel)
* Replace "www.yourdomain.com" with your domain name or Maropost sub-domain. (If you are using a subdomain (eg. store.yourdomain.com) remove the "www")
2. Mouse over **Setup & tools** and click on **Staff users.**!
3. Click **Add New**.
4. Fill out all the fields as shown below, save the new API user, and note down the Username and API Key for the next step
## 2. Enter your API details in Starshipit
1. Log into [Starshipit](https://app2.starshipit.com/) and go to **Settings** > **Integrations** > **Add new integration** > **Neto**.
2. Enter your Maropost Site URL, Username and API Key from the previous step.
3. Click on **Save**.
If you have any issues completing this set up, please contact our support team [here](https://help.starshipit.com).
## Notes
* Starshipit import Signature required from Maropost (ShippingSignature)
* When Maropost returns a product image named **Main**, Starshipit imports its URL to the order item. If Maropost does not provide a Main image, Starshipit uses the legacy `ImageURL` value when available.
---
# Connect Microsoft Dynamics 365 Business Central to Starshipit
URL: https://support.starshipit.com/articles/12093647173647-connect-microsoft-dynamics-365-business-central-to-starshipit
Canonical: https://support.starshipit.com/articles/12093647173647-connect-microsoft-dynamics-365-business-central-to-starshipit
Markdown: https://support.starshipit.com/articles/12093647173647-connect-microsoft-dynamics-365-business-central-to-starshipit.md
Updated: 2026-08-07
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Connect Microsoft Dynamics 365 Business Central to import sales documents and write back tracking information.
Connect Starshipit to Microsoft Dynamics 365 Business Central to import sales orders or sales invoices and write back package tracking information.
:::important
This connector is specifically for **Microsoft Dynamics 365 Business Central**. It does not connect Starshipit to every product in the Dynamics 365 suite.
:::
## Before you begin
You need:
- A Microsoft Dynamics 365 Business Central account with admin access to authorise Starshipit.
- An environment and company in Business Central to import from.
- The [Starshipit Integration extension from Microsoft AppSource](https://marketplace.microsoft.com/en-us/product/dynamics-365-business-central/PUBID.shipitlimited1742346367585%7CAID.starshipit%7CPAPPID.37578f37-5111-40bc-ac9f-744211f27790) if you want tracking-number writeback. The extension is not used to import orders.
## Connect Business Central
1. In Starshipit, go to **Settings > Integrations**.
2. Select **Add a new integration**, then select **D365BC**.
3. Turn on **Enable Dynamics 365 Business Central**.
4. Select **Authorize**, then sign in with a Microsoft account that can approve access to Business Central.
5. Select the Business Central **Environment** and **Company** to import from.
6. Select an **Import Type**, **Bound Action**, and **Status**.
7. Select **Save**.
8. Go to your orders and select **Fetch latest orders** to test the import.
After the enabled integration is saved, Starshipit also imports matching documents automatically.
## Choose what to import
| Setting | Available options | How it works |
| --- | --- | --- |
| **Import Type** | **Sales Order**, **Sales Invoice** | Selects the standard Business Central API document to import. **Sales Order** is the default. |
| **Status** | **DRAFT**, **OPEN** | Filters the status returned by the Business Central API. **DRAFT** is the default. |
| **Bound Action** for Sales Order | **NONE**, **SHIPANDINVOICE** | After tracking writeback, **SHIPANDINVOICE** asks Business Central to ship and invoice the order. **NONE** is the default. |
| **Bound Action** for Sales Invoice | **NONE**, **POST**, **POSTANDSEND**, **SEND** | After tracking writeback, the selected action asks Business Central to process the invoice. **NONE** is the default. |
## Import released sales orders
Business Central uses different labels for document status in its UI and its standard API:
| Business Central UI status | Standard API status | Starshipit **Status** |
| --- | --- | --- |
| **Open** | `Draft` | **DRAFT** |
| **Pending Approval** | `In Review` | Not available as a Starshipit status option |
| **Released** | `Open` | **OPEN** |
| **Pending Prepayment** | `Open` | **OPEN** |
To import released sales orders, select **Sales Order** as the **Import Type** and **OPEN** as the **Status**.
:::important
Microsoft's standard API maps both **Released** and **Pending Prepayment** sales orders to API status `Open`. Starshipit's native status filter cannot import only **Released** while excluding **Pending Prepayment**. If you need that distinction, you need a custom integration or product change.
:::
## Understand how imports and writeback work
Starshipit imports documents through Microsoft's standard [Business Central API v2.0 sales order](https://learn.microsoft.com/en-us/dynamics365/business-central/dev-itpro/api-reference/v2.0/resources/dynamics_salesorder) and [sales invoice](https://learn.microsoft.com/en-us/dynamics365/business-central/dev-itpro/api-reference/v2.0/resources/dynamics_salesinvoice) endpoints. The Starshipit Integration extension does not provide an order-import endpoint.
The extension provides a separate endpoint for tracking writeback. When an imported document is fulfilled in Starshipit, Starshipit sends the first package's tracking number to Business Central's **Package Tracking No.** field. If you selected a bound action other than **NONE**, Starshipit then calls that standard Business Central action.
Tracking writeback supports only:
- Sales Orders.
- Draft Sales Invoices.
## Check the destination address mapping
Starshipit maps the destination directly from the imported document's Ship-to fields:
| Starshipit destination field | Business Central API field or rule |
| --- | --- |
| Recipient | `shipToName`; if empty, `shipToContact`; if empty, `customerName` |
| Company | `shipToName` when `shipToContact` is also present and is different from `shipToName`; otherwise blank |
| Street | `shipToAddressLine1` |
| Building / address line 2 | `shipToAddressLine2` |
| Suburb | `shipToAddressLine2`; if empty, `shipToCity` |
| City | `shipToCity` |
| State | `shipToState` |
| Country | `shipToCountry` |
| Postcode | `shipToPostCode` |
| Phone | Order-level `phoneNumber` |
| Email | Order-level `email` |
Street and address values therefore come from the sales order's **Ship-to** fields. Starshipit does not perform a separate customer-card address lookup during import.
There is no configurable address-source selector. Using Sell-to, Bill-to, or custom fields requires customisation.
## Verify released-order and Ship-to imports
Use a small test before relying on automatic imports:
1. In Starshipit, configure **Import Type** as **Sales Order**, **Status** as **OPEN**, and **Bound Action** as **NONE**.
2. In the selected Business Central company, create two recent sales orders with unique order numbers.
3. Leave one sales order with the Business Central UI status **Open**.
4. Override the other sales order's **Ship-to** address so it differs from the customer card, then release that order.
5. In Starshipit, select **Fetch latest orders**.
6. Confirm that the released order imports and the unreleased order does not.
7. Open the imported order and confirm that its destination matches the overridden **Ship-to** address.
If a **Pending Prepayment** order also imports, this is expected because the standard API reports it as `Open`.
## Troubleshooting
If the expected order does not import:
- Confirm the integration is enabled and authorised.
- Confirm you selected the environment and company containing the order.
- For a released sales order, confirm **Import Type** is **Sales Order** and **Status** is **OPEN**.
- Fetch the latest orders again after changing or releasing the order.
- Check the order's Ship-to fields in Business Central if the destination is unexpected.
If tracking does not write back, confirm the Starshipit Integration extension is installed and that the imported document is a Sales Order or Draft Sales Invoice.
## Configure Business Central settings
| Setting | What it controls |
| --- | --- |
| **Enable** | Turns the Dynamics 365 Business Central connection on or off. |
| **Connection status** | Shows whether Starshipit has a current Microsoft authorisation. This is a status indicator, not an editable setting. |
| **Environment** | Selects the Business Central environment to use. |
| **Company** | Selects the Business Central company whose records Starshipit imports. The list is filtered by the selected environment. |
| **Import type** | Selects **Sales Order** or **Sales Invoice** as the source record type. |
| **Action** | Selects the action applied to the chosen import type, such as `SHIPANDINVOICE` for sales orders or `POST`, `POSTANDSEND`, and `SEND` for sales invoices. |
| **Status** | Selects the source status to import: `DRAFT` or `OPEN`. |
Use **Authorize** to connect or refresh Microsoft access. Click **Save** after changing settings, then use **Test connection** to verify the selected environment and company.
---
# Connect MYOB AccountRight to Starshipit
URL: https://support.starshipit.com/articles/205394059-connect-myob-accountright-to-starshipit
Canonical: https://support.starshipit.com/articles/205394059-connect-myob-accountright-to-starshipit
Markdown: https://support.starshipit.com/articles/205394059-connect-myob-accountright-to-starshipit.md
Updated: 2026-09-03
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Learn how to integrate your MYOB AccountRight platform with Starshipit.
Connect MYOB AccountRight Cloud to Starshipit to import orders or invoices and write shipment details back to MYOB.
:::important
Only MYOB Cloud accounts are supported. Inventory Locations are not supported.
:::
## Before you begin
Have access to the MYOB company file you want to connect. You also need to create an offline MYOB user for Starshipit.
## Authorise MYOB
1. Go to **Settings > Integrations > Add a new integration**.
2. Under **Other Platforms**, select **MYOB** and turn on **Enable MYOB**.
3. Click **Authorize**.
4. Sign in with your my.MYOB account and click **Allow access**.
## Create an offline MYOB user
1. Open the company file in the AccountRight desktop application on Windows.
2. Go to **Setup > User Access** and create an **Offline User**.
3. Give the user the **Administrator**, **Cards**, and **Sales** company-file roles.
4. Clear **This user will sign on with a my.MYOB account (Recommended)**.
5. Set a username and password for the offline user.
## Complete the connection
1. In Starshipit, select the **Company file name** that exactly matches the name shown in AccountRight's Command Centre.
2. Enter the offline user's **Company file username** and **Company file password**.
3. Click **Save**, then use **Test connection** to confirm access.
4. Choose whether to import orders, invoices, or both. If needed, enter **Ship Via** values separated with a semicolon, such as `Air; DHL`.
### Do not use customer card email or phone when missing from order/invoice
When MYOB orders or invoices do not include recipient email or phone details, Starshipit can normally use the email and phone from the linked MYOB customer card. This is useful for many merchants, so the default behaviour remains unchanged.
Enable **Do not use customer card email or phone when missing from order/invoice** if you dispatch on behalf of other customers, or if your MYOB customer card contact details do not represent the final shipping recipient.
When this setting is enabled, Starshipit leaves the recipient email and phone blank if they are missing from the MYOB order or invoice, rather than copying them from the customer card.
This setting affects newly imported orders going forward. It does not automatically clean up or update orders that have already been imported.
### SKU mapping
Starshipit imports item SKUs from MYOB AccountRight using the MYOB item number. In MYOB this may appear as **Item Number**. When an order or invoice imports into Starshipit, the item number is mapped to the SKU field on the order line.
If SKUs are missing from imported orders:
1. Check that the items on the MYOB order or invoice have item numbers.
2. Confirm the order was imported after the item numbers were added in MYOB.
3. Re-import or create a new test order to confirm the SKU appears in Starshipit.
This mapping applies to newly imported orders. Updating item numbers in MYOB does not automatically update orders that have already been imported into Starshipit.
## Configure MYOB AccountRight settings
| Setting | What it controls |
| --- | --- |
| **Enable MYOB** | Turns the MYOB connection on or off. |
| **Company file name** | Selects the AccountRight company file to use. The name must match AccountRight exactly. |
| **Company file username** | The offline AccountRight user created for Starshipit. |
| **Company file password** | The password for the offline AccountRight user. |
| **Ship Via** | Limits imports to orders with the selected MYOB Ship Via value. Separate multiple values with a semicolon; leave empty to import all. |
| **Import orders** | Includes MYOB orders in Starshipit imports. |
| **Orders status** | Selects whether open, closed, or both order statuses are imported. |
| **Import invoices** | Includes MYOB invoices in Starshipit imports. |
| **Invoices status** | Selects whether open, closed, or both invoice statuses are imported. |
| **Delivery instructions** | Chooses whether tracking details are written to the Journal Memo field, Comment field, or both. |
| **Convert order to an invoice on update** | Converts a MYOB order to an invoice when Starshipit updates it. |
| **Use product description from order/invoice** | Uses the MYOB product description instead of the product name. |
| **Use customer details from order/invoice** | Uses recipient details on the order or invoice instead of the linked customer record. |
| **Do not use customer card email or phone when missing from order/invoice** | Leaves email and phone blank when they are absent from the order or invoice, instead of using the customer card. |
| **Use optimized import filters** | Uses faster filters for company files larger than 2 GB. |
| **Disable writeback** | Stops shipment and tracking updates being sent back to MYOB. This is not recommended for normal fulfilment. |
Click **Save** after changing settings. Use **Test connection** to verify access; the Tools tab can also retrieve company file names and inspect an order.
---
# Connect MYOB Acumatica to Starshipit
URL: https://support.starshipit.com/articles/13959285704335-connect-myob-acumatica-to-starshipit
Canonical: https://support.starshipit.com/articles/13959285704335-connect-myob-acumatica-to-starshipit
Markdown: https://support.starshipit.com/articles/13959285704335-connect-myob-acumatica-to-starshipit.md
Updated: 2026-09-03
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Learn how to connect MYOB Acumatica (formerly MYOB Advanced) with Starshipit for imports and tracking updates.
Connect your **MYOB Acumatica** (formerly MYOB Advanced) account to Starshipit to automate order imports, shipping, and tracking updates. This guide explains how to connect your Acumatica API, configure import settings, and map carriers for writeback.
## What you’ll need
* A MYOB Acumatica account with API access enabled
* Your Acumatica server URL (e.g. *https://your-server.acumatica.com*)
* A valid API username and password with web service access
* Tenant and branch identifiers (if applicable)
* API endpoint name and version (e.g. *22.200.001*)
## Step 1: Connect your MYOB Acumatica account
1. In Starshipit, go to **Settings > Integrations**.
2. Click **Add a new integration** and select **MYOB Acumatica**.
3. In the **Connection Settings** section, fill out each field as described below.
| Field | Description |
| --- | --- |
| **Enabled** | Tick to activate the integration. |
| **Endpoint URL** | Enter your Acumatica server URL (for example, *https://your-server.acumatica.com*). |
| **Username / Password** | Enter your Acumatica API credentials. The account must have web service access. |
| **Tenant** | Enter the tenant name or ID in Acumatica. |
| **Branch** | (Optional) Enter a specific branch to import orders from. Leave blank to include all branches. |
| **Company** | Enter the Acumatica company when your endpoint has more than one company. |
| **Import Orders** | Turns on order imports for this connection. |
| **Writeback Tracking** | Sends tracking details back to Acumatica after shipment. |
4. Click **Test Connection** to verify your credentials.
5. If successful, click **Save** to confirm your configuration.
## Step 2: Configure import settings
These options define how Starshipit imports and updates orders from MYOB Acumatica.
The following settings are in the **Advanced** tab:
| Setting | What it controls |
| --- | --- |
| **Warehouse** | Limits imports and write-back to the specified Acumatica warehouse. |
| **Order Type** | Limits imports to the specified Acumatica sales-order type. |
| **Shipment Type** | Uses the specified Acumatica shipment type for write-back. |
**Include Unit of Measure (UOM) in SKU**
When enabled, item SKUs are formatted as `InventoryID/UOM`. When disabled, only the Inventory ID is used.
**Get destination address from customer record**
When enabled, Starshipit pulls the destination address from the customer record. When disabled, it uses the shipping address first and the customer record as a fallback.
**Confirm shipment on tracking writeback**
Automatically confirms shipments in Acumatica after tracking updates are sent from Starshipit.
**Set shipment on hold if confirm fails**
Places shipments on hold in Acumatica if confirmation fails during writeback.
**Writeback Quantity Field**
Defines which Acumatica field receives the shipped quantity (default is `ShippedQty`).
**Order Types to Import**
Specify Acumatica order types to import, separated by semicolons (e.g. `SO;RMA;TR`). Leave blank to import all order types.
## Step 3: Configure carrier mappings
1. Scroll to the **Carrier Mappings** section.
2. Click **Add a new mapping**.
3. Select a Starshipit carrier and enter the corresponding MYOB Acumatica carrier name.
4. Click **Save** when finished.
If no mapping is defined, Starshipit will use the carrier’s default name during writeback.
## Step 4: Save and test your setup
1. Click **Save** to store all settings.
2. Click **Test Connection** again to confirm communication between Starshipit and Acumatica.
3. Once verified, order imports and writebacks will start based on your configuration.
## Troubleshooting
#### Why am I getting an error saying that "Box ID 'Package Name' cannot be found in the system"?
This error appears when the package name in Starshipit doesn’t exactly match the box or package name in MYOB Acumatica. Check that the name in both platforms is identical.
---
# Connect NetSuite to Starshipit
URL: https://support.starshipit.com/articles/213384326-connect-netsuite-to-starshipit
Canonical: https://support.starshipit.com/articles/213384326-connect-netsuite-to-starshipit
Markdown: https://support.starshipit.com/articles/213384326-connect-netsuite-to-starshipit.md
Updated: 2026-09-03
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Integrate your NetSuite platform with Starshipit to import orders and write back tracking information when you print labels.
Integrate your NetSuite platform with Starshipit to import orders and write back tracking information when you print labels. You can configure Starshipit to import Item Fulfilments, Sales Orders or Invoices.
## Before you begin
You need a NetSuite administrator who can create a token-based authentication role, integration record, and access token.
## Prepare NetSuite access
1. Go to **Setup > Company > Enable Features > SuiteCloud**. Enable **Client SuiteScript**, **Server SuiteScript**, and **Token-Based Authentication**, then save.
2. Go to **Setup > Users/Roles > Manage Roles > New**. Name the role `Starshipit Integration Role`, select **Web Services Only Role**, then add the permissions below at **Full** level.
| Permission group | Permissions |
| --- | --- |
| Transactions | Find Transactions, Fulfill Orders, Item Fulfillment, Sales Order |
| Lists | Items, Currency |
| Setup | User Access Tokens, SOAP Web Services |
3. Assign **Starshipit Integration Role** to the NetSuite user that will own the connection.
## Create the integration and token
1. Go to **Setup > Integration > Manage Integrations > New** and name it `Starshipit TBA`.
2. Enable **User Credentials** and **Token-Based Authentication**. Disable **Authorization Code Grant** and **TBA: Authorization Flow**, then save.
3. Copy the **Consumer Key** and **Consumer Secret** from the integration record.
4. Go to **Setup > Users/Roles > Access Tokens > New**. Select `Starshipit TBA`, the assigned user, and **Starshipit Integration Role**, then save.
5. Copy the **Token ID** and **Token Secret** from the confirmation page.
6. Go to **Setup > Integration > Web Services Preferences** and copy the **Account ID**.
## Connect NetSuite in Starshipit
1. Go to **Settings > Integrations > Add a new integration > NetSuite** and turn on **Enable NetSuite**.
2. Select **Token-Based** authentication.
3. Enter the account ID exactly as NetSuite provides it, then enter the consumer key, consumer secret, token ID, token secret, role ID, and application ID.
4. If you have multiple subsidiaries or locations, use the **Advanced** tab to limit the records this connection uses.
5. Turn on **Sync Fulfilments** when Starshipit should synchronise NetSuite fulfilment records.
6. Click **Save**, then **Test to ensure it works**.
Use **Use Sandbox** only when you are connecting to a NetSuite sandbox rather than production.
## Import Custom Fields
The following information can be imported from NetSuite to Starshipit when the values are stored in custom fields with designated script ids:
* **Delivery Instructions** - custbody_delivery_instructions (Text Custom Field)
* **Authority To Leave** - custbody_authority_to_leave (Boolean Custom Field)
* **Signature Required** - custbody_signature_required (Boolean Custom Field)
## Troubleshooting
The NetSuite API limits each NetSuite user to a single API connection based on the user's login credentials. This can cause Starshipit that use a NetSuite connection to fail with the following errors if other calls are made to the NetSuite API using the same credentials:
* Only one request may be made against a session at a time
* The operation has timed out
If the error occurred while updating your NetSuite orders, then Starshipit will try to update these orders again in a scheduled fashion to ensure the orders are being updated in NetSuite.
Alternatively, you can purchase concurrent connection licenses from NetSuite which will permit simultaneous requests from the same user account.
For temporary testing purposes, you can point Starshipit to your NetSuite sandbox environment by appending the sandbox Id to your Web Service Account Id, e.g. '1234567_SB1' (this has '_SB1' appended).
---
# NetSuite: Troubleshooting
URL: https://support.starshipit.com/articles/360000145916-netsuite-troubleshooting
Canonical: https://support.starshipit.com/articles/360000145916-netsuite-troubleshooting
Markdown: https://support.starshipit.com/articles/360000145916-netsuite-troubleshooting.md
Updated: 2026-05-07
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Learn how to troubleshoot and resolve common issues with the NetSuite integration.
This article outlines common errors with the Starshipit/NetSuite integration and how to resolve them. For setup instructions, see [how to integrate with NetSuite](/articles/integrations/inventory-warehouse-retail-management/netsuite-integration).
## Error with writeback
The NetSuite API limits each NetSuite user to a single API connection based on the user's login credentials. This can cause Starshipit accounts that use a NetSuite connection to fail if other calls are made to the NetSuite API using the same credentials.
The following errors may be seen:
* Only one request may be made against a session at a time
* The operation has timed out
Starshipit will try to update these orders again in a scheduled fashion to ensure they are being updated in NetSuite. Alternatively, you can purchase concurrent connection licenses from NetSuite which will permit simultaneous requests from the same user account.
## Netsuite Mapping
| Field | Maps to | Info |
| --- | --- | --- |
| SourceKey | "IF" + ItemFulfillment.internalId OR "INV" + Invoice.internalId OR SalesOrder.internalId | |
| OurRef | tranId (transaction ID) from ItemFulfillment / Invoice / SalesOrder | |
| SequenceStr | tranId | |
| TheirRef | otherRefNum | |
| Date | tranDate | |
| Email | email | |
| OrderCurrency | currency.symbol (ISO 4217 code) or currency.name | |
| ShippingMethod | shipMethod.name | |
| OrderValue | Sum of (Item.Price * Item.Quantity) or total (Invoice/SalesOrder) | |
| AddressDetails.Instructions | Custom field custbody_delivery_instructions or custbody4 | String/Select |
| ATL (Authority to Leave) | Custom field custbody_authority_to_leave or custbody_atl_check_box | Boolean |
| SignatureRequired | Custom field custbody_signature_required | Boolean |
| AddressDetails.Company | shippingAddress.addressee | If attention is also present |
| To | shippingAddress.attention or addressee | Fallbacks applied |
| Telephone | shippingAddress.addrPhone | |
| AddressDetails.Building | shippingAddress.addr1 | When addr2 & addr3 present |
| AddressDetails.Street | shippingAddress.addr2 | Multi-line fallback logic |
| AddressDetails.Suburb | shippingAddress.addr3 | Fallback logic |
| AddressDetails.City | shippingAddress.city | |
| AddressDetails.State | shippingAddress.state | |
| AddressDetails.PostCode | shippingAddress.zip | |
| AddressDetails.Country | shippingAddress.country | Converted to full name via GetCountryName |
| ProductIdentifier | item.internalId | |
| SKU | ItemAttributes.upcCode | Or itemId if UseItemIdAsSKU is true |
| Weight | ItemAttributes.GetWeightKg() | Derived from weight & weightUnit |
| Country | countryOfManufacture | Converted via GetCountryName |
| HSCode | manufacturerTariff | |
| Description | description HTML replaced with space, or item.name | |
| Quantity | quantity | |
| Price | amount / quantity | From order line item |
| CustomField | line | Order line number, when specified |
---
# Connect NewStore to Starshipit
URL: https://support.starshipit.com/articles/90200000000113-connect-newstore-to-starshipit
Canonical: https://support.starshipit.com/articles/90200000000113-connect-newstore-to-starshipit
Markdown: https://support.starshipit.com/articles/90200000000113-connect-newstore-to-starshipit.md
Updated: 2026-05-25
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Connect NewStore to Starshipit so NewStore can request shipping offers and book shipments.
Connect NewStore to Starshipit so NewStore can request shipping offers and book shipments through Starshipit. This is a webhook-based integration, so NewStore sends shipping requests to Starshipit instead of Starshipit importing orders on a schedule.
## What you need before you start
To connect NewStore to Starshipit, you need:
* Admin access to your Starshipit account
* Access to configure NewStore delivery webhooks
* A Starshipit API key or token for the NewStore Authorization header
* The carrier services you want NewStore to offer, already set up in Starshipit
:::important
Do not publish or share merchant-specific API keys in support tickets or public documentation. Treat the Authorization header value like a password.
:::
## 1. Set up your carriers in Starshipit
Before connecting NewStore, set up the couriers and services you want NewStore to use.
1. In Starshipit, go to **Settings** > **Couriers**.
2. Add and enable the couriers you want to use for NewStore shipments.
3. Add any required product or service codes for those couriers.
4. Confirm you can create labels with those courier services in Starshipit.
NewStore can only return offers and book shipments for carrier services that are available in your Starshipit account.
## 2. Enable NewStore in Starshipit
1. In Starshipit, go to **Settings** > **Integrations** > **Add a new integration**.
2. Select **NewStore**.
3. Enable the NewStore integration.
4. Save your settings.
After saving, your Starshipit account is ready to receive NewStore shipping offer and shipment booking requests.
## 3. Configure NewStore webhooks
Configure NewStore to send delivery webhook requests to Starshipit.
| NewStore action | Starshipit endpoint |
| --- | --- |
| Shipping offers | [`https://newstore.starshipit.com/api/integrations/newstore/v1/shipping_offers`](https://newstore.starshipit.com/api/integrations/newstore/v1/shipping_offers) |
| Book shipment | [`https://newstore.starshipit.com/api/integrations/newstore/v1/shipments`](https://newstore.starshipit.com/api/integrations/newstore/v1/shipments) |
Set the shipping offers webhook in NewStore to the exact URL above. NewStore must call this endpoint when it needs the delivery options that Starshipit can offer. Use the `/shipments` endpoint only when NewStore is booking a shipment.
Both webhook requests must include the Starshipit API key or token in the Authorization header. Starshipit uses this to find the correct Starshipit account.
NewStore can also send an optional `X-Request-ID` header to help trace requests.
## How the integration works
When NewStore asks for shipping offers, Starshipit checks the sender address, receiver address, deliverables, ready-by time, and available carrier services. Starshipit then returns the available shipping offers sorted by price.
When NewStore books a shipment, Starshipit creates or finds the matching Starshipit order, creates the shipment and label, then returns the tracking details and label information to NewStore.
## Limitations
* NewStore is webhook-based. Starshipit does not import NewStore orders on a schedule.
* Shipment cancellation through the NewStore cancel shipment webhook is not supported in this version.
* Advanced or bulk manifest workflows are not supported in this version.
* Shipping offers expire 15 minutes after Starshipit returns them.
* Booking requests need an external order ID, booking method, sender address, receiver address, and at least one item.
## Troubleshooting
**No shipping offers are returned?**
Check that:
* The Authorization header uses the correct Starshipit API key or token.
* Sender and receiver country codes are valid.
* Sender and receiver address details are complete.
* The request includes at least one deliverable.
* The ready-by time is valid.
* The required carrier services and rates are set up in Starshipit.
**Shipment booking is failing?**
Check that:
* The request includes an external order ID and booking method.
* Sender and receiver addresses include first name, last name, address line 1, city, country code, and postcode or zip code.
* Item and package details are complete.
* The selected carrier service is available in Starshipit.
* Starshipit can generate a label for the selected service.
**The same order is sent more than once?**
Starshipit checks the external order ID before creating a new order. If NewStore sends the same external order ID again, Starshipit attempts to use the existing order instead of creating a duplicate.
---
# Fulfil Odoo orders with Starshipit
URL: https://support.starshipit.com/articles/90200000000504-fulfil-odoo-orders-with-starshipit
Canonical: https://support.starshipit.com/articles/90200000000504-fulfil-odoo-orders-with-starshipit
Markdown: https://support.starshipit.com/articles/90200000000504-fulfil-odoo-orders-with-starshipit.md
Updated: 2026-07-20
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Get a Starshipit shipping rate in Odoo, generate labels and tracking, create return labels, and correctly cancel shipments.
Use the Starshipit shipping method in Odoo to calculate shipping, create labels, and receive tracking numbers.
## Before you begin
[Connect Odoo to Starshipit](/articles/9226374129295-integrating-with-odoo) and select the Starshipit service you want to use.
## Get a rate and generate labels
1. Open or create a quotation in Odoo.
2. Click **Add shipping**.
3. Select Starshipit in **Shipping Method**.
4. Click **Get rate**.
5. Click **Add** to add the shipping cost to the sales order.
6. Validate the delivery.
Odoo adds the generated shipping labels and tracking numbers to the chatter. Return labels also appear when the selected service supports returns and the connector is configured accordingly.
:::important
Odoo calculates package weight from the product weights plus the empty package weight. Verify the package, destination address, email address, and phone number before creating the shipment.
:::
## Create a return label
Returns are supported for Australia Post eParcel, TNT, CouriersPlease, Aramex, StarTrack, DHL Express, and NZ Post Domestic.
1. Open the delivery order in Odoo.
2. Click **Return**.
3. Click **Print Return Label**.
The button is available only when the selected courier service supports returns.
## Cancel a delivery
Cancelling a delivery order in Odoo archives it in Starshipit, but does not cancel the shipment with the courier. Sign in to the courier portal and cancel the shipment there to avoid unintended charges.
---
# Connect Odoo to Starshipit
URL: https://support.starshipit.com/articles/9226374129295-connect-odoo-to-starshipit
Canonical: https://support.starshipit.com/articles/9226374129295-connect-odoo-to-starshipit
Markdown: https://support.starshipit.com/articles/9226374129295-connect-odoo-to-starshipit.md
Updated: 2026-07-20
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Connect the Odoo Starshipit Shipping module and configure a shipping method using your Starshipit credentials and services.
Connect the Odoo Starshipit Shipping module to Starshipit so Odoo can retrieve shipping rates, create labels, and receive tracking numbers.
:::note
The integration is managed by Odoo. Contact Odoo support if you cannot install or configure the Starshipit module in Odoo.
:::
## Before you begin
In Starshipit, configure:
- Your pickup address under **Settings > Pickup address**.
- At least one courier under **Settings > Couriers**.
- Checkout rates for each courier you want to make available in Odoo.
- Your API and subscription keys under **Settings > API**.
## Install the Starshipit module
1. In Odoo, open **Apps**.
2. Search for **Starshipit Shipping**.
3. Click **Activate**.
4. Go to **Inventory > Configuration > Settings**.
5. Enable **Starshipit Connector**.
6. Open **Starshipit Shipping Methods**, then click **Create**.
## Configure the shipping method
1. Enter `Starshipit` for **Shipping Method**.
2. Select **Starshipit** as the provider.
3. Select or create the delivery product shown on sales-order lines when Odoo calculates shipping.
4. Under **Starshipit Configuration**, enter your Starshipit API key, subscription key, origin address, and default package type.
5. Save the form using the cloud icon beside the breadcrumb.
6. Click **Select a service linked to the Starshipit account**.
7. Select the delivery and return service, then click **Confirm**.
:::important
Enable Odoo's **Packages** feature under **Inventory > Configuration > Settings** before selecting a default package type.
:::
## Verify the connection
Create a test quotation, select the Starshipit shipping method, and click **Get rate**. Confirm Odoo returns the expected Starshipit service and rate.
:::warning
Starshipit does not provide test API keys. Odoo test environments may cancel created labels automatically, but some couriers can still charge for label creation. Check the courier account after testing.
:::
Next, learn how to [fulfil Odoo orders with Starshipit](/articles/90200000000504-fulfil-odoo-orders-with-starshipit).
---
# Odoo FAQs and troubleshooting
URL: https://support.starshipit.com/articles/90200000000505-odoo-faqs-and-troubleshooting
Canonical: https://support.starshipit.com/articles/90200000000505-odoo-faqs-and-troubleshooting
Markdown: https://support.starshipit.com/articles/90200000000505-odoo-faqs-and-troubleshooting.md
Updated: 2026-07-20
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Resolve unavailable Odoo delivery methods and understand how Recommended Packaging works with the Starshipit connector.
Find answers and fixes for common questions about the Odoo Starshipit Shipping module.
## Fix an unavailable delivery method
The error `This delivery method is not available for this order` means Odoo requested shipping options but Starshipit did not return an applicable rate.
1. Confirm the courier is connected under **Settings > Couriers** in Starshipit.
2. [Set up or update Rates at Checkout](/articles/rates-at-checkout/set-up-guides/set-up-rates-at-checkout) for that courier.
3. Confirm the order destination, weight, and dimensions match the configured rate conditions.
4. Request the rate again in Odoo.
Does Recommended Packaging work with Odoo?
Yes. It works when item dimensions are configured in [Product Catalogue](/articles/integrations/product-catalogue/product-catalogue) and Odoo does not send its own packaging information on the order. Starshipit then calculates the recommended package for the rate request.
---
# Connect OpenCart to Starshipit
URL: https://support.starshipit.com/articles/204502855-connect-opencart-to-starshipit
Canonical: https://support.starshipit.com/articles/204502855-connect-opencart-to-starshipit
Markdown: https://support.starshipit.com/articles/204502855-connect-opencart-to-starshipit.md
Updated: 2026-05-06
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Integrate your OpenCart store with Starshipit to automatically import orders and write back tracking numbers when you print labels.
OpenCart is an easy-to-use, powerful, open-source online store management program that can manage multiple online stores from a single back-end. This guide shows you how to integrate your OpenCart store with Starshipit so orders automatically import and tracking numbers are written back when you print labels.
## 1. Download and install the Starshipit extension for OpenCart
There are three OpenCart extensions available from Starshipit. Be sure to check your OpenCart store version and download the correct version. You can download the extension on [this link](https://www.opencart.com/index.php?route=marketplace/extension/info&extension_id=33254).
## 2. Create API access for Starshipit in OpenCart
1. Log in to your OpenCart Administration site.
2. Go to **Settings** > **Users** > **API**.
3. Complete API Name.
4. Generate the API Key.
5. Set Status as **Enabled**.
6. Go to the **IP Addresses** Tab.
7. Add the following IP addresses:
* 104.40.200.176
* 104.40.201.109
* 104.40.204.252
* 104.40.205.110
* 104.40.205.29
* 125.236.208.143
* 13.69.68.2
* 13.70.65.114
* 13.70.65.145
* 13.70.67.84
* 13.70.71.54
* 13.70.71.83
* 13.73.195.135
* 13.75.138.224
* 13.75.144.52
* 13.75.144.82
* 13.75.145.35
* 13.75.149.31
* 137.117.153.170
* 222.154.228.31
* 23.101.208.53
* 23.101.208.54
* 23.101.208.55
* 23.101.208.56
* 23.97.146.237
* 13.70.71.54
8. Click **Save**.
## 3. Add OpenCart integration with API details in Starshipit
1. In Starshipit navigate to **Settings** > **Integrations** > **Add a new integration** > **OpenCart**.
2. Tick **Enable OpenCart**.
3. Tick **Use API**.
4. Enter in your store URL.
5. Select your OpenCart version range - 3.0.2.0 or earlier, or 3.0.30 or later.
6. Enter the API Name and API Key created in the previous step.
7. Click **Save**.
## Troubleshooting
- I have successfully integrated my OpenCart shop but the orders are not coming through.
--> Per default Starshipit import the order with Status = Pending, make sure you have Pending order in OpenCart, or change the "Status to Import" in the settings.
## Supported versions
Starshipit's extension supports the following versions of OpenCart:
**Version 2**
2.0.1.1 - 2.3.0.2
**Version 3**
3.0.0.0, 3.0.1.1, 3.0.1.2, 3.0.2.0
3.0.3.0, 3.0.3.1, 3.0.3.2, 3.0.3.3, 3.0.3.5, 3.0.3.6, 3.0.3.7, 3.0.3.8
## Configure the OpenCart settings
Complete these settings when you connect OpenCart. You can update them later from **Settings > Integrations > OpenCart**.
| Setting | What it controls |
| --- | --- |
| **Enable OpenCart** | Turns the integration on or off. |
| **Use API** | Uses the OpenCart API connection. When this is off, Starshipit uses the legacy PHP connection. |
| **URL** | Your OpenCart store URL. |
| **Version** | Selects the OpenCart version range used by the extension: **3.0.2.0 or earlier**, **3.0.3.0 or later**, or **4.0.0.0 or later**. |
| **API Name** | The API name created in OpenCart. |
| **API key** | The API key created in OpenCart. Keep it private. |
| **Status** | The OpenCart order status that Starshipit imports. The available values come from your store. |
| **Do not import notes** | Stops OpenCart order notes being copied into Starshipit. |
**Version**, **API Name**, **API key**, **Status**, and **Do not import notes** appear when **Use API** is enabled. Save the settings and use **Test connection** to confirm the connection.
# OpenCart Legacy Integration (deprecated)
## 1. Implement the PHP files on your website
1. Please download the files from [here](https://app.shipit.click/clientbin/opencart.zip).
2. Once downloaded, extract the .zip file. It includes an import.php file and update.php file.
3. Login into your Starshipit account and get your API Key which is available under Settings > API Key
4. Once you have created your key, enter it into the second line of each file above.
5. Look for $apiKey= "Get key from Settings > API Key"; and replace the part of the = with your key
6. Copy Files to Server
7. Navigate to your OpenCart server root directory and copy the two files from above into the admin folder.
## 2. Enter the path of the PHP files in Starshipit
1. In the Starshipit Main menu Click on Settings > Integration > Add New and select OpenCart from the Add Integration List.
2. Tick the 'Enabled' checkbox at the top of the page and enter the full URL to the admin folder on your site (i.e. http://www.yourwebsite.com/admin/).
3. Then click 'Save' to apply your changes.
## 3. Troubleshooting
Q. My orders have not been imported
A. The first step is to verify is that the import.php file is well located and accessible by Starshipit.
Try to access the following URL through your browser: http://www.yourwebsite.com/admin/import.php - if the browser is returning a 404 error please go back and redo the previous steps.
If it returns an execution error, [submit a support ticket](https://support.starshipit.com/ticket).
---
# Update tracking with plain labels (Using Orca Scan)
URL: https://support.starshipit.com/articles/9075642572815-update-tracking-with-plain-labels-using-orca-scan
Canonical: https://support.starshipit.com/articles/9075642572815-update-tracking-with-plain-labels-using-orca-scan
Markdown: https://support.starshipit.com/articles/9075642572815-update-tracking-with-plain-labels-using-orca-scan.md
Updated: 2026-05-06
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Orca Scan enables users to quickly scan barcodes using a smartphone, capturing and exporting data to various formats for easy analysis.
## How you can use Orca Scan with Starshipit
If you use your own delivery drivers ([with plain labels](/articles/couriers/plain-label/how-to-use-plain-labels)), they can use Orca Scan to update the delivery status of the orders they're delivering. For example, when they deliver a package, they can scan the barcode on the shipping label using Orca Scan, which then updates the status in Starshipit.
This will trigger the same email notifications as if you were using another carrier. It will also add the same delivery time stamps to your reports, so you can track the performance of your own delivery drivers.
## Set up plain labels in Starshipit
Given that Orca Scan works with Starshipit's plain labels feature (for example when you're using your own delivery drivers as explained in the above example), we'll need to set up a plain label courier in Starshipit.
1. Go to **Settings** > **Couriers**.
2. Click **Add a new courier**.
3. Under Other, select **Plain Label**.
4. Select **Enable a plain label**.
5. Enter the name of your carrier.
6. Click **Label Template**.
7. Tick **Use tracking number when available for barcode**.
8. Click **Save**.
:::note
Read [the full plain label guide here](/articles/couriers/plain-label/how-to-use-plain-labels) to learn more about how you can configure these labels to fit your needs.
:::
## Set up Orca Scan
Register for an Orca Scan account:
1. Head over to the [Orca Scan registration page](https://cloud.orcascan.com/).
2. Click **Create account**.
Once you’ve registered for an account you will be asked to create your first sheet. You can think of a sheet as a totally separate database, each with its own uniquely defined fields.
1. Log in to your Orca Scan account at [cloud.orcascan.com.](https://cloud.orcascan.com/)
2. We’ll need to add a new sheet to Orca Scan to be the list of orders we scan. Here’s how to do this:
* Click the **+** symbol in Orca Scan.
* Click **Sheet** to create a new sheet.
* On this new sheet, create a new column by right-clicking on a column and selecting **Add column**.
* Name the column **Status.**
* Change the Data type to **Drop-Down list**.
* Under List options, add the values **PickedUp** and **Delivered**. These are the two options currently configured in the integration to update the order status with.
3. Click **Integrations** to connect it to your Starshipit account
4. Enter the following details in the Settings page:
| | |
| --- | --- |
| WebHook Out | https://staging.starshipit.com/api/OrcaScan |
| Secret | Your Starshipit [API key](/articles/integrations/the-starshipit-api/how-to-find-your-starshipit-api-key) |
5. Download the Orca Scan mobile app from the [iOS](https://apps.apple.com/us/app/orca-scan/id1161117971) or [Android](https://play.google.com/store/apps/details?id=com.orcascan.bulkbarcodescanner&hl=en_us) app store.
6. Log into your account using Orca Scan mobile.
## Testing Orca Scan
Now, we're ready to test Orca Scan with Starshipit. You can either use one of your own plain labels or our test label below. By scanning this barcode using the Orca Scan app, this should add a row to your sheet in Orca Scan.
## Using Orca Scan with Starshipit (Typical workflow)
Now that we've set up both Starshipit and Orca Scan, here's what a typical workflow might look like:
### In Starshipit
* Open the order you wish to print a plain label for.
* Enter the tracking number in the order details screen.
* Print the label.
Note: The tracking number will print as the barcode, as long as you have ticked **Use tracking number when available for barcode**in the plain label settings.
### For your delivery driver (Using Orca Scan app)
* Open the Orca Scan app on your mobile device.
* Ensure you've selected the sheet from the top of the app.
* Scan a barcode on the plain label generated earlier.
* On scanning, you will get this screen:
* Choose either **PickedUp** or **Delivered** for the status.
* When you click **Save & Close**, the order will update in Starshipit with the relevant status.
---
# Connect Order Desk to Starshipit
URL: https://support.starshipit.com/articles/6720958030735-connect-order-desk-to-starshipit
Canonical: https://support.starshipit.com/articles/6720958030735-connect-order-desk-to-starshipit
Markdown: https://support.starshipit.com/articles/6720958030735-connect-order-desk-to-starshipit.md
Updated: 2026-09-03
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Integrate Starshipit with Order Desk to import your Order Desk orders using your API key.
Integrate Starshipit with Order Desk to import your Order Desk orders.
## Before you begin
You'll first need to obtain your Order Desk API Key. You can find this by following these steps:
1. Obtain your Order Desk API Key by logging into your Order Desk admin panel using your personal URL: http://your-account.assistly.com/admin
2. Click **Settings**.
3. From the menu on the left select **API** > **My Applications**.
4. Copy the Order Desk API Key.
## How it works
Integrating Order Desk with Starshipit is easy, and only requires a few steps.
Order Desk must be authorised before you can use it. If you haven't done so already, follow below steps:
1. In Starshipit, navigate to **Settings** > **Integrations**
2. Click **Add a new integration** and select **Order Desk** in the list.
3. Tick **Enable Order Desk**.
4. Enter your **Store ID**.
5. Enter your Order Desk API Key.
6. Enter **Folder ID** if you want Starshipit to import only orders from one Order Desk folder. Leave it blank to use the connection's default scope.
7. Turn on **Import Buyer Checkout Message** when the buyer's checkout message should be included with imported order information.
8. Click **Save**, then select **Test connection** to verify the credentials before relying on automatic imports.
---
# Configure Peoplevox labels, couriers, and packages
URL: https://support.starshipit.com/articles/90200000000501-configure-peoplevox-labels-couriers-and-packages
Canonical: https://support.starshipit.com/articles/90200000000501-configure-peoplevox-labels-couriers-and-packages
Markdown: https://support.starshipit.com/articles/90200000000501-configure-peoplevox-labels-couriers-and-packages.md
Updated: 2026-07-20
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Configure Peoplevox print templates and control how Starshipit selects couriers and creates packages for Peoplevox orders.
Configure the labels, couriers, and package behaviour used when Peoplevox despatches an order through Starshipit.
## Before you begin
[Connect Peoplevox to Starshipit](/articles/360000934795-peoplevox-integration) before configuring this workflow.
## Create print templates in Peoplevox
1. In Peoplevox, switch to the **Setup** view.
2. Select **Print Templates**.
3. Select **DespatchPackage** for outgoing labels and commercial invoices, or **Returns** for return documents.
4. Click **Search**, then open the template you want to use.
5. Set **Registered template name** to the applicable document type:
- `Outgoing label`
- `Commercial invoice`
- `Returns label`
- `Returns commercial invoice`
6. Click **Save**.
## Add templates to the carrier connection
1. Switch to the **Integration** view in Peoplevox.
2. Open **Carrier Integration**, select Starshipit, then click **Edit**.
3. Under **Document Types**, enter a name and select the corresponding print template.
4. Set **Reference** to the exact applicable value listed above.
5. Click **Save**.
Start with the outbound label and test it before adding the other document types.
## Set default couriers
Starshipit automatically generates labels when orders are despatched in Peoplevox, so each order needs a courier and product code.
1. In Starshipit, go to **Settings > Couriers**.
2. Select default domestic and international couriers.
3. Open each default courier and select a default product code.
4. If required, use [shipping rules](/articles/notifications-branded-tracking-rules-child-accounts/business-rules/rules-based-on-shipping-method) to select different couriers or services.
## Configure package creation
Go to **Settings > Integrations > Peoplevox** and select the package behaviour that matches your workflow:
- **Create package using item weights from Peoplevox order** creates one shipment using weights from the Peoplevox despatch items.
- **Create packages using package details from Peoplevox orders** creates packages from the names and dimensions sent by Peoplevox.
When using Peoplevox package details:
- A Peoplevox package name matching a Starshipit package uses the Starshipit dimensions.
- An unmatched package name uses the dimensions sent by Peoplevox.
- A package without a name uses the default Starshipit package dimensions.
To combine packages into one shipment, enable **Consolidate multi-packages into one shipment**. Starshipit waits until `totalPickedItems` matches `totalDespatchedItems`, then generates the labels.
## Verify the configuration
Despatch a test order that uses your expected package and courier. Confirm Peoplevox receives the correct label and tracking number.
---
# Connect Peoplevox to Starshipit
URL: https://support.starshipit.com/articles/360000934795-connect-peoplevox-to-starshipit
Canonical: https://support.starshipit.com/articles/360000934795-connect-peoplevox-to-starshipit
Markdown: https://support.starshipit.com/articles/360000934795-connect-peoplevox-to-starshipit.md
Updated: 2026-07-20
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Connect Peoplevox to Starshipit so orders can flow into Starshipit and shipping labels and tracking can flow back to Peoplevox.
Connect Peoplevox to Starshipit so allocated or despatched orders can be sent to Starshipit and labels and tracking numbers can be returned to Peoplevox.
:::important
Peoplevox may charge an additional subscription fee to enable its carrier integration module. Confirm access with Peoplevox before you begin.
:::
## Before you begin
You need:
- Admin access to Starshipit.
- Access to the **Integration** view in Peoplevox.
- Your Peoplevox client ID, username, password, and region if you want orders sent when stock is allocated.
## Add Peoplevox in Starshipit
1. In Starshipit, go to **Settings > Integrations**.
2. Click **Add a new integration**, then select **Peoplevox**.
3. Enter a display name for the integration.
4. Select the region used by your Peoplevox instance:
- **Americas (US)**
- **Asia Pacific (AP)**
- **Europe (WMS)**
5. Map the Peoplevox sales-order attributes used for company name, building, phone number, currency code, and delivery instructions.
6. If required, map attributes 1–15 for HS code and country of manufacture.
7. Click **Save**.
## Receive orders when stock is allocated
This optional subscription sends orders to Starshipit earlier, giving you time to correct invalid addresses before despatch.
1. Enter the **Client ID**, **Username**, and **Password** used to access Peoplevox.
2. Set **Requested Delivery Date** to a recent date to prevent historical orders from importing.
3. Click **Save**.
4. Click **Test** and confirm the result is **Successful**.
5. Click **Subscribe**.
## Add Starshipit as a carrier integration in Peoplevox
1. In Peoplevox, switch to the **Integration** view.
2. Select **Carrier Integration**, then click **Add New**.
3. Enter `Starshipit` as the name.
4. Set **Date time format** to `dd/MM/yyyy hh:mm:ss`.
5. Set **Timeout (ms)** to `30000`.
6. Copy the **API key** and **Endpoint** from **Settings > Integrations > Peoplevox** in Starshipit.
7. Paste both values into Peoplevox.
8. Set **Tracking number format** to `{returns}/{outbound}`.
9. Click **Save**.
:::note
If Starshipit shows only a partial API key, go to **Settings > API** and click **Generate**, then return to the Peoplevox integration to copy the full key.
:::
## Verify the connection
Allocate or despatch a test order in Peoplevox. Confirm the order appears in Starshipit and that despatching it returns its label and tracking number to Peoplevox.
Next, [configure Peoplevox labels, couriers, and packages](/articles/90200000000501-configure-peoplevox-labels-couriers-and-packages).
## Configure Peoplevox settings
The integration settings control how Peoplevox data is mapped into Starshipit and how shipments are returned.
| Setting | What it does |
| --- | --- |
| **Display name** | Names this Peoplevox connection in Starshipit. |
| **Region** | Selects the Peoplevox region for the connection. |
| **Company name**, **Building**, **Phone number**, **Currency code**, **Tags**, **Duties amount**, **Delivery instructions**, **Contact name**, **HS code**, **Manufacture country**, and **MID code** | Map each Starshipit order or item field to a matching Peoplevox custom property or attribute. |
| **Client ID**, **Username**, **Password** | Credentials for the Peoplevox API. |
| **Filter date** | Limits the Peoplevox records considered for import from the selected date. |
| **Use staging URL** | Connects to the Peoplevox staging environment instead of production. |
| **Subscription ID** | Identifies the Peoplevox subscription used by the connection. |
| **Do not run rules on label print** | Prevents Starshipit rules from running again when a label is printed. |
| **Re-run cheapest carrier rules before label printing** | Re-evaluates the cheapest-carrier rule before printing. |
| **Import address line 2 to building** | Places Peoplevox address line 2 in Starshipit’s Building field. |
| **Import package type** | Imports the Peoplevox package type. |
| **Import item descriptions** | Imports item descriptions with the order lines. |
| **Package weights** / **Package details** | Choose whether Starshipit uses package weights or Peoplevox despatch-package dimensions and details. When package details are selected, choose the **Dimensions unit**. |
| **Consolidate shipment** | Combines Peoplevox packages into one Starshipit shipment when the despatch is complete. |
| **Writeback service type** | Sends the Starshipit service type back to Peoplevox. |
Save the settings, then despatch a test order to confirm the mappings and writeback behave as expected.
---
# Troubleshoot Peoplevox
URL: https://support.starshipit.com/articles/90200000000502-troubleshoot-peoplevox
Canonical: https://support.starshipit.com/articles/90200000000502-troubleshoot-peoplevox
Markdown: https://support.starshipit.com/articles/90200000000502-troubleshoot-peoplevox.md
Updated: 2026-07-20
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Resolve Peoplevox label-generation failures, inspect event logs, and resend orders that were deleted from Starshipit.
Use this guide when Peoplevox cannot generate a label through Starshipit or an expected order is missing.
## A failover label prints
A failover label usually means the courier rejected the shipment because of an address or order-data error.
1. Find the affected order in Starshipit.
2. Correct the address or other reported error.
3. In Peoplevox, find the despatch and click **Print**.
4. Click **Print** next to the package.
5. Confirm the shipping label and tracking number are returned to Peoplevox.
## Check Peoplevox event logs
1. In Peoplevox, switch to the **Integration** view.
2. Select **Event Logs**.
3. Find the request for the affected despatch.
4. Review the Starshipit API response for the specific error.
:::note
The message `Carrier Integration could not matched print Request: - 1` is common and can usually be ignored when labels otherwise generate successfully.
:::
## An order was deleted from Starshipit
Peoplevox pushes orders into Starshipit. If an order is deleted from Starshipit, resend it from Peoplevox rather than running a Starshipit import.
---
# Peoplevox FAQs
URL: https://support.starshipit.com/articles/90200000000503-peoplevox-faqs
Canonical: https://support.starshipit.com/articles/90200000000503-peoplevox-faqs
Markdown: https://support.starshipit.com/articles/90200000000503-peoplevox-faqs.md
Updated: 2026-07-20
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Answers to common questions about Peoplevox writeback, address changes, Product Catalogue settings, and multi-package consolidation.
Find answers to common questions about the Starshipit Peoplevox integration.
Can Starshipit write the selected service back to Peoplevox?
Yes. Configure each service in Peoplevox with an outbound reference in the format `_`. Find the correct value under **Settings > Integrations > Peoplevox > Tools**, then enable **Write back service type to Peoplevox** in the Peoplevox integration settings.
If Peoplevox cannot match the reference, it records the carrier as `unknown`.
Why does an address changed in Peoplevox not update in Starshipit?
When the allocation subscription is enabled, Peoplevox creates the Starshipit order when stock is allocated. Later Peoplevox address changes are not sent to that existing order.
To create the order only at despatch, go to **Settings > Integrations > Peoplevox** and disable the subscription. Address changes made before despatch will then be included when Peoplevox sends the order.
Can I use Product Catalogue with Peoplevox?
Yes. The settings configured in [Product Catalogue](/articles/integrations/product-catalogue/product-catalogue) apply when a Peoplevox order is despatched for label generation.
How does multi-package consolidation work?
When **Consolidate multi-packages into one shipment** is enabled, Starshipit keeps adding packages to the unshipped order until `totalPickedItems` matches `totalDespatchedItems`. It then generates and returns the labels to Peoplevox.
---
# Connect PrestaShop to Starshipit
URL: https://support.starshipit.com/articles/360000647096-connect-prestashop-to-starshipit
Canonical: https://support.starshipit.com/articles/360000647096-connect-prestashop-to-starshipit
Markdown: https://support.starshipit.com/articles/360000647096-connect-prestashop-to-starshipit.md
Updated: 2026-02-11
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Integrate PrestaShop with Starshipit by creating webservice access and mapping your couriers to enable order imports and write-back.
## 1. Create webservice access in PrestaShop
#### Enable PrestaShop's webservice
1. Log in to your PrestaShop admin account.
2. Under **Configure**, select **Advanced Parameters**, then select **Webservice**.
3. Toggle **Enable PrestaShop's webservice** to **YES**, then click **Save**.
#### Create a new webservice account
1. In the top right, click **Add new webservice key**.
2. Click **Generate!** to generate a new key.
3. Select the following resources: **View (GET)**, **Modify (PUT)** and **Add (POST)**by selecting the checkboxes at the top of the column.
4. Click **Save**.
## 2. Add your webservice in Starshipit
1. In Starshipit, navigate to **Settings** > **Integrations**.
2. Click **Add a new integration**, and select **PrestaShop** from the list.
3. Tick **Enable PrestaShop**.
4. Enter your PrestaShop **Store URL**.
5. Copy and paste the webservice key from your PrestaShop admin page.
6. Fill in other details as required.
7. Click **Save**.
## 3. Map your Starshipit courier to the PrestaShop Courier ID
To enable order write-back, you'll need to map the couriers in your Starshipit account to the courier ID in PrestaShop. To do this:
1. In Starshipit, navigate to **Settings** > **Integrations** > **PrestaShop Settings**.
2. Click **Add a new mapping**.
3. Enter the associated carrier ID from PrestaShop to the courier in Starshipit.
You can find the PrestaShop ID in your PrestaShop admin account > Shipping > Carriers.
4. Click **Save**, then click the tick icon to confirm.
**For example**: I want to map 'Australia Post' to 'Australia Post ID 3' from PrestaShop.
## 4. Specify the Status to Import
In Starshipit, you can specify the status of the order to be imported. During setup, enter the status number in the **Status to Import** field. You can update it later from **Settings > Integrations**. Add multiple statuses by separating them with a semicolon.
The most common statuses are:
* 3 = Processing
* 4 = Shipped
You can find a list of the different status ID's in your PrestaShop account:
* PrestaShop v1.6.x - Orders > Statuses.
* PrestaShop v1.7.x - Shop Parameters > Order Settings > Statuses.
## Configure PrestaShop settings
| Setting | What it does |
| --- | --- |
| **Enable PrestaShop** | Turns the integration on or off. |
| **Store URL** | The URL of your PrestaShop store. |
| **Web Service Key** | The PrestaShop web service key used by Starshipit. Keep it private. |
| **Statuses to import** | The PrestaShop order status IDs Starshipit imports. Enter multiple IDs as supported by the field. |
| **Status to update** | The PrestaShop status Starshipit applies after fulfilment. |
| **Map address line 2 as suburb** | Maps the second address line to Starshipit’s Suburb field instead of Building. |
Save your settings and use **Test connection** before enabling automatic imports.
---
# Connect QuickBooks Commerce to Starshipit
URL: https://support.starshipit.com/articles/203448859-connect-quickbooks-commerce-to-starshipit
Canonical: https://support.starshipit.com/articles/203448859-connect-quickbooks-commerce-to-starshipit
Markdown: https://support.starshipit.com/articles/203448859-connect-quickbooks-commerce-to-starshipit.md
Updated: 2026-05-06
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> QuickBooks Commerce (formerly TradeGecko) integration is no longer supported as of June 10, 2022.
:::important
TradeGecko Sunsetting: QuickBooks have announced that QuickBooks Commerce standalone (formerly TradeGecko) will no longer be available starting on June 10, 2022. Starshipit has also ceased support for this integration inline with this announcement. If you're looking for a new Inventory Management System, check out our recommendations here.
:::
## 1. Open Settings page
1. In Starshipit, navigate to **Settings** > **Integration** > **Add a new integration**.
2. Select TradeGecko list, and you will be directed to the TradeGecko settings page.
## 2. Enter your Quickbooks Commerce (TradeGecko) credentials
Tick **Enable TradeGecko** and then click **Authorise**. You will be taken through to Quickbooks Commerce (TradeGecko) where you can authorise our application and then you will be returned to Starshipit.
## 3. Import your orders
You are now ready to import your orders from Quickbooks Commerce (TradeGecko). Click the "NEW" tab at the top of the page in Starshipit. Once you are on the shipments page, click the Import button, select TradeGecko and the number of days you wish to import. Then click the 'Import' button at the bottom right.
After a brief load time, it will display the number of imported orders. Click 'Close' and it will re-load your shipping page with the newly imported orders. You should now see your shipments.
## 4. Notes
Starshipit has the following features currently available for its Quickbooks Commerce (TradeGecko) integration:
* Writeback
* Partial Shipments
* Import Weight
* Import multiple order status
* Item descriptions
Not supported:
* Import dimensions
* Live rates at checkout
* Allow multiple integrations
* Add-on Extension or App.
#### Automatic Import
Starshipit can automatically import your orders from Quickbooks Commerce (TradeGecko) every 20 minutes or you can run a manual import as often as you like by clicking the “import” button on the Ship screen.
Once the orders are imported you can sort and filter the orders however you like.
---
# Connect Sellercloud to Starshipit
URL: https://support.starshipit.com/articles/11771153103887-connect-sellercloud-to-starshipit
Canonical: https://support.starshipit.com/articles/11771153103887-connect-sellercloud-to-starshipit
Markdown: https://support.starshipit.com/articles/11771153103887-connect-sellercloud-to-starshipit.md
Updated: 2026-09-03
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Learn how to integrate with SellerCloud.
Integrate Starshipit with Sellercloud to seamlessly import your orders and automate fulfillment. Orders from Sellercloud will automatically sync with Starshipit, tracking details will be sent back once orders are fulfilled, and order status updates will be handled automatically.
## What you need to get started
* A **Sellercloud account** with API access.
* Your **Sellercloud subdomain** (e.g., **yourcompany**.sellercloud.com).
* Your **Sellercloud username and password** with the necessary permissions.
## How to set up Sellercloud
1. In your Starshipit account, go to **Settings >** **Integrations**.
2. Click **Add a new integration** and select **Sellercloud** from the list.
3. Turn on **Enable Sellercloud**.
4. Enter your **Username**, **Password**, **Subdomain**, and **TLD (Top Level Domain)**. For example, use `com` for a `sellercloud.com` address.
5. Choose the **Status** to import, or enter **Saved View ID(s)** to use Sellercloud saved views instead. Separate multiple saved-view IDs with semicolons.
6. Click **Save**, then select **Test connection** to verify the connection.
### Set the order status to import OR set the Saved View ID to import
1. In **Settings** > **Integrations**, select **Sellercloud settings**
2. Choose the **order status to import** from the dropdown menu.
3. Alternatively, enter the Saved View ID(s) (if setting multiple, separate these with a ";")
4. Click **Save**.
Once saved, click **Fetch latest orders** to confirm your integration is working correctly.
## Additional import settings
The **Advanced** tab contains two optional import mappings:
| Setting | Use it when |
| --- | --- |
| **Use Product ID as SKU (instead of Reference ID)** | Sellercloud product IDs, rather than reference IDs, are the SKU values your Starshipit rules and products use. |
| **Use alternate order number (Completed Order ID / Order Source Order ID)** | Your operational order reference is the completed-order or source-order ID instead of Sellercloud's default order number. |
## Additional Features
**Order Status Sync**: Orders will **automatically update** in Sellercloud when they are shipped from Starshipit.
Tracking information will be sent back to Sellercloud, updating the order status.
---
# Configure Shopify order import
URL: https://support.starshipit.com/articles/90200000000204-configure-shopify-order-import
Canonical: https://support.starshipit.com/articles/90200000000204-configure-shopify-order-import
Markdown: https://support.starshipit.com/articles/90200000000204-configure-shopify-order-import.md
Updated: 2026-09-03
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Set up and adjust how Starshipit imports orders from Shopify, including status filters, locations, delivery methods, tags, webhooks, and checkout-rates-only mode.
Starshipit's Shopify import settings control which orders come through, when they arrive, and what triggers a skip. All settings are found at **Settings > Integrations > Shopify Settings**.
Import settings are divided into the **main settings tab** and the **Advanced tab**. This article covers all import-related settings in both.
## Status filter
The status filter is the most common reason orders do not import. The setting name and available options differ between Classic and Enhanced.
### Classic: order status
Classic uses the Shopify **order status**. Only orders matching the selected status will import.
Available options:
| Option | When to use |
| --- | --- |
| Open | Orders that are placed and not yet fulfilled or closed. The most common choice. |
| Paid | Orders with payment completed. |
| Partially Refunded | Orders where part of the payment has been refunded. |
| Closed | Orders that have been archived or closed in Shopify. |
| Cancelled | Cancelled orders. Rarely used for import. |
| Any | All orders regardless of status. Use with caution. |
### Enhanced: financial status
Enhanced uses the Shopify **financial status** on the parent order. Fulfillment-order filters (location, delivery method) are applied after the financial status check.
Available options:
| Option | When to use |
| --- | --- |
| Paid | Orders that are fully paid. The most common choice. |
| Authorized | Payment authorised but not yet captured. |
| Pending | Payment pending (for example, bank transfers or cash on delivery). |
| Partially Paid | Partial payment received. |
| Partially Refunded | Order partially refunded. |
| Refunded | Order fully refunded. |
| Voided | Payment void. |
| Unpaid | Order placed without payment. |
| Any | All orders regardless of financial status. Use with caution. |
## Locations (Enhanced only)
The **Locations** filter controls which Shopify assigned fulfillment locations Starshipit imports from. The location refers to the Shopify fulfillment order's assigned location, not the Starshipit sender address.
- **All Locations** — Starshipit imports fulfillment orders from every location. This is the default.
- **Specific location** — Only fulfillment orders assigned to the selected Shopify location will import.
Use a specific location when you run multiple child Starshipit accounts, one per Shopify location. See [Shopify Enhanced: locations, delivery methods, and split fulfillment](/articles/integrations/shopify/shopify-enhanced-locations-delivery-split-fulfillment) for the full multi-location setup guide.
If the location list is empty or not loading, reauthorise the Shopify integration — this is usually a permissions issue.
## Delivery methods (Enhanced only)
The **Delivery Methods** filter controls which Shopify fulfillment order delivery types are imported.
| Option | What it imports |
| --- | --- |
| Shipping | Orders for home or business delivery. Selected by default. |
| Local Delivery | Orders where the customer is nearby and has opted for local delivery. |
| Local Pick Up | Orders the customer will collect in person. |
**Shipping** is selected by default. Add **Local Delivery** or **Local Pick Up** if you want those fulfillment orders imported.
:::note
Shopify does not always include delivery method data on every fulfillment order. Fulfillment orders without delivery method data are treated as **Shipping** by Starshipit. If known pickup orders keep importing when only Shipping is selected, use an import rule to exclude them by tag or shipping description.
:::
For more detail on pickup and split fulfillment behaviour, see [Shopify Enhanced: locations, delivery methods, and split fulfillment](/articles/integrations/shopify/shopify-enhanced-locations-delivery-split-fulfillment).
## Excluded tags
The **Exclude orders with these tags** field prevents orders with specific Shopify tags from importing. Enter one or more tags separated by semicolons. Tags are not case-sensitive.
This is the recommended way to manage pre-orders and back-orders:
1. In Starshipit, go to **Settings > Integrations > Shopify** and open the **Advanced** tab.
2. In the **Exclude orders with these tags** field, enter the tag you will use — for example, `preorder`.
3. In Shopify, add that tag to any order you want to hold back.
4. When you are ready to ship the order, remove the tag in Shopify. The order will import on the next import cycle.
## Fraud check
When fraud checking is enabled, Starshipit skips orders where Shopify's risk analysis recommends cancellation. The order is not imported.
To enable: go to **Settings > Integrations > Shopify > Advanced** and enable **Enable Fraud Check**.
If a legitimate order is being skipped by fraud checking, review the order's risk details in Shopify directly.
## Additional import criteria
The following options are in **Settings > Integrations > Shopify > Advanced**. Leave them at their defaults unless the description matches your workflow.
| Setting | What it does |
| --- | --- |
| **Disable the 500 order import limit** | Lets one import retrieve more than 500 orders. The limit keeps normal imports faster, so use this only when you need to import a larger backlog. |
## Map Shopify data to Starshipit fields
Use **Settings > Integrations > Shopify > Advanced > Field mapping** when your Shopify data needs to arrive in a particular Starshipit field. Enable only the options you need.
| Setting | What it does |
| --- | --- |
| **Import tags from Shopify** | Imports Shopify order tags so you can see them on the order and use them in Starshipit rules. |
| **Import country specific tax IDs** | Imports destination tax identifiers, such as CPF/CNPJ or RFC, for supported countries. |
| **Import country specific HS codes** | Uses the inventory item's destination-country HS code when one is available; otherwise Starshipit uses its generic HS code. |
| **Import DHL service point metafield** | Imports the `delivery.service_point_id` order metafield. Leave this off unless you use DHL service points. |
| **Use Shopify pickup location address for local pickup orders** | For Enhanced integrations, uses the assigned Shopify location address when a local-pickup order has no shipping address and Shopify provides complete location details. |
| **Import product dimensions metafields** | Imports dimensions from product or product-variant metafields. Use the matching entity and choose the unit for numeric values. Supported keys are `shipping_length`, `shipping_width`, and `shipping_height`, or `length`, `width`, and `height`. |
| **Import bin location metafield** | For Enhanced integrations, imports a bin location from the selected product or product-variant metafield. The metafield key must be `bin_location` and use a one-value, single-line-text definition. |
| **Map address line 2 into "Building" field** | Sends Shopify address line 2 to Starshipit's **Building** field instead of **Suburb**. |
| **Map order notes** | Choose whether Shopify order notes are not imported, go to delivery instructions, go to the notes section, or go to both. |
| **Import order number prefix and suffix** | Keeps Shopify's order-number prefix and suffix when importing the order number. |
| **Map the name of product variants for order item descriptions** | Uses the Shopify variant name as the item description instead of the product title. |
| **Import shipping as a line item** | Adds the amount paid for shipping as a `Shipping` line item on the imported order. |
| **Import item quantity instead of fulfillable quantity** | Imports the ordered quantity rather than the fulfillable quantity. This can include deleted items, so it is not normally recommended. |
| **Import item properties as line items (multi-buy bundles)** | For Classic integrations, turns properties saved on one bundle line item into separate imported line items. |
| **Expand bundle products on import** | Expands bundle products into their individual items based on the bundle SKU. |
| **Consolidate shipping methods** | Combines all Shopify shipping-line titles into one value and writes it to the Starshipit shipping-method field. |
## Webhooks
Webhooks allow Shopify to push order updates to Starshipit in near real time, rather than waiting for the scheduled import cycle (which runs approximately every 20 minutes).
To subscribe:
1. Go to **Settings > Integrations > Shopify Settings**.
2. Scroll to the bottom of the page and click **Subscribe to webhook**.
When a webhook is active, eligible Shopify order updates arrive in Starshipit within seconds of being created or updated.
If the webhook subscription fails:
- Save your Shopify settings first, then try subscribing again.
- If the subscription still fails, reauthorise the Shopify integration and try once more.
:::note
Webhooks require a saved Shopify integration. Switching between Classic and Enhanced may replace the webhook subscription — resave and resubscribe after any version change.
:::
## Checkout-rates-only mode
Enable **Use for checkout rates only** when this Shopify integration should return shipping rates at Shopify checkout but should not import orders.
When this setting is on:
- Starshipit will not import any orders through this integration.
- Shopify checkout rates continue to work normally.
- This is useful when orders are imported through a different system, such as a warehouse or inventory management platform.
See [Shopify: Rates at checkout](/articles/rates-at-checkout/platform-specific-guides/shopify-rates-at-checkout) for the checkout rate setup guide.
---
# Connect Shopify to Starshipit
URL: https://support.starshipit.com/articles/90200000000202-connect-shopify-to-starshipit
Canonical: https://support.starshipit.com/articles/90200000000202-connect-shopify-to-starshipit
Markdown: https://support.starshipit.com/articles/90200000000202-connect-shopify-to-starshipit.md
Updated: 2026-05-27
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Step-by-step guide to connecting your Shopify store to Starshipit, choosing Classic or Enhanced, and reauthorising when needed.
Connect your Shopify store to Starshipit to import orders, print labels, and send tracking updates back to Shopify. You can connect as many Shopify stores as you need — each one is set up as a separate integration.
:::warning
Complete this setup through [app2.starshipit.com](https://app2.starshipit.com) directly. The process will not work if you start from inside the Shopify App or the Print Application.
:::
## Before you begin
You need:
- Your **Shopify store name** — this is the part of your Shopify URL that appears between `https://` and `.myshopify.com`. For example, if your URL is `https://amazing-clothing.myshopify.com`, your store name is `amazing-clothing`.
- Your Shopify account login (username and password).
- A decision on whether to use **Shopify Classic** or **Shopify Enhanced**. If you are unsure, see [Shopify Classic vs Enhanced: which should I use?](/articles/integrations/shopify/shopify-classic-vs-enhanced). For most new setups, Enhanced is recommended.
## Connect your Shopify store
1. In Starshipit, go to **Settings > Integrations**.
2. Click **Add a new integration** and select **Shopify** from the list.
3. Under **Integration Version**, select **Classic** or **Enhanced**.
4. Enter your shop name (without `.myshopify.com`).
5. Click **Authorise**. You will be redirected to Shopify to log in and grant Starshipit access.
6. Complete the authorisation in Shopify. You will be redirected back to Starshipit automatically.
7. Click **Test** to confirm the connection is working.
8. Configure your import settings, then click **Save**.
The integration is now active. Eligible Shopify orders will begin importing on the next scheduled import cycle, or immediately if you [subscribe to webhooks](/articles/integrations/shopify/configure-shopify-order-import#webhooks).
## Switch between Classic and Enhanced
You can change the integration version at any time from **Settings > Integrations > Shopify Settings**.
Before switching, be aware of the following:
- **Webhook subscriptions may change.** Classic and Enhanced use different webhook identifiers. Switching can update or replace the existing webhook subscription. After switching, save your settings and resubscribe to webhooks.
- **Import behaviour changes.** Classic imports at the Shopify order level. Enhanced imports at the fulfillment-order level. Any orders already in Starshipit are unaffected, but new orders will be imported under the rules of the new version.
- **Order references may differ.** Enhanced appends a suffix when one Shopify order creates more than one Starshipit shipment (for example, `#1001-1` and `#1001-2`). Switching to Enhanced for an existing store means merchants need to search using this format going forward.
## Reauthorise Shopify
Reauthorisation is required when:
- Shopify settings or permissions have changed.
- The integration cannot retrieve locations, fulfillment orders, or inventory data.
- A webhook subscription cannot be created or is failing.
- You have changed your Shopify plan or app permissions.
To reauthorise:
1. Go to **Settings > Integrations > Shopify Settings**.
2. Click **Authorise** again and complete the process in Shopify.
3. Return to Starshipit, save your settings, and resubscribe to webhooks if needed.
:::note
Reauthorisation requests the current set of required permissions from Shopify. This is the first step for most connectivity or permission-related issues.
:::
---
# Configure Shopify Enhanced locations and fulfilment
URL: https://support.starshipit.com/articles/90200000000205-configure-shopify-enhanced-locations-and-fulfilment
Canonical: https://support.starshipit.com/articles/90200000000205-configure-shopify-enhanced-locations-and-fulfilment
Markdown: https://support.starshipit.com/articles/90200000000205-configure-shopify-enhanced-locations-and-fulfilment.md
Updated: 2026-05-27
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> How Shopify Enhanced handles multiple locations, local pickup orders, and orders that split into more than one Starshipit shipment.
Shopify Enhanced imports at the fulfillment-order level, not the order level. This is what makes it possible to filter by Shopify location or delivery method, support local pickup orders, and handle stores where one customer order ships from more than one place.
This article explains how each of those scenarios works in practice.
## How Shopify locations work with Enhanced import
When Shopify fulfills an order, it assigns each fulfillment order to a **location** — the Shopify location responsible for shipping those items. Starshipit uses this assigned location when filtering imports.
- **All Locations** (default) — Starshipit imports fulfillment orders from every Shopify location. This is the right choice for single-location stores or when you want everything in one Starshipit account.
- **Specific location** — Only fulfillment orders assigned to that location import. Use this when each Shopify location has its own Starshipit account.
The location filter is set at **Settings > Integrations > Shopify Settings > Locations**.
:::note
If the location list does not load, the integration may not have permission to read Shopify location data. Reauthorise the Shopify integration to resolve this.
:::
## Multi-location setup with child accounts
If your store uses multiple Shopify fulfillment locations and you want each location managed by a separate Starshipit account:
1. Create a [Starshipit child account](/articles/360000553016) for each location.
2. Connect Shopify Enhanced to each child account.
3. In each child account's Shopify settings, select the Shopify location that corresponds to that account.
Starshipit will then only import fulfillment orders assigned to that location into the matching account. Orders from other locations are ignored.
If the Shopify location list does not load in a child account, reauthorise Shopify and try again.
:::note
Child account workflows can differ when your Starshipit subscription is billed through Shopify. If you are Shopify-billed and need child accounts, contact [Starshipit support](https://help.starshipit.com) before changing your setup.
:::
## Local pickup orders
Local pickup orders are orders where the customer chose to collect their items in person rather than have them shipped. These orders often have no customer shipping address in Shopify.
**Classic cannot import local pickup orders without a shipping address.** Starshipit Classic requires a shipping address to create a shipment.
**Enhanced handles local pickup** by supporting Shopify fulfillment orders with delivery method `Local Pick Up`. When a pickup order is imported, Starshipit needs an address for the shipment record. It uses one of these two sources:
- **Starshipit sender address** — the default fallback when no other address is configured.
- **Shopify assigned pickup location address** — if you enable **Use Shopify pickup location address for Local Pick Up orders** in Starshipit settings, and Shopify provides the assigned location address, that address is used instead.
To enable the Shopify location address option: go to **Settings > Integrations > Shopify > Advanced** and enable **Use Shopify pickup location address for Local Pick Up orders**.
:::note
If Shopify does not provide the assigned location address for a pickup order, Starshipit falls back to the sender address even when this setting is on.
:::
Shopify does not always provide delivery method data. Fulfillment orders with no delivery method data are treated as **Shipping**. If pickup or local delivery orders still import unexpectedly, use a reliable Shopify tag or shipping-description import rule to exclude them.
After a pickup order is processed, Starshipit can also mark it as **ready for pickup** in Shopify instead of creating a standard fulfillment. See [Write back tracking and fulfillment to Shopify](/articles/integrations/shopify/shopify-writeback#pickup-ready-for-pickup) for more on this.
## Split fulfillment: one Shopify order, multiple Starshipit shipments
When Shopify splits a customer order into more than one fulfillment order — for example, because items are at different locations, or because some items have a different fulfillment service — Starshipit imports each fulfillment order as its own shipment.
**Example:**
A customer places one order for two items. Item A is at the Sydney warehouse; item B is at the Auckland warehouse. Shopify creates two fulfillment orders. Starshipit imports both, creating `#1001-1` and `#1001-2`.
**Order reference suffixes**
When one Shopify order creates more than one Starshipit shipment, Starshipit appends a numeric suffix to the order reference to keep each shipment unique:
- `#1001` → `#1001-1` and `#1001-2`
If you or your team search Starshipit by the original Shopify order number, search for `1001` without the suffix — results for all related shipments will appear.
**This is expected behaviour.** If you see multiple Starshipit shipments for one Shopify order, it means Shopify created multiple fulfillment orders for that order. It is not a duplicate or an error.
If you want to understand why a specific order split, open the order in Shopify and review its fulfillment orders. The assigned locations and fulfillment groups shown there will match what Starshipit imported.
---
# Shopify FAQs
URL: https://support.starshipit.com/articles/90200000000208-shopify-faqs
Canonical: https://support.starshipit.com/articles/90200000000208-shopify-faqs
Markdown: https://support.starshipit.com/articles/90200000000208-shopify-faqs.md
Updated: 2026-06-23
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Answers to frequently asked questions about the Starshipit Shopify integration.
Which Shopify integration version should I use — Classic or Enhanced?
Use **Enhanced** for most new setups, especially if you use Shopify locations, local pickup, local delivery, split fulfillment, or partial fulfillment writeback. Keep **Classic** only if your existing order-level workflow is working and you do not need any Enhanced features.
See [Shopify Classic vs Enhanced: which should I use?](/articles/integrations/shopify/shopify-classic-vs-enhanced) for the full comparison and decision table.
Why did one Shopify order create multiple Starshipit shipments?
In Shopify Enhanced, Starshipit imports Shopify **fulfillment orders**, not Shopify orders. If Shopify splits one order into multiple fulfillment orders — for example, because items are at different locations or fulfillment groups — Starshipit creates a separate shipment for each fulfillment order.
Each shipment gets a suffix: for example, Shopify order `#1001` becomes `#1001-1` and `#1001-2`. This is expected behaviour for split fulfillment. See [Shopify Enhanced: locations, delivery methods, and split fulfillment](/articles/integrations/shopify/shopify-enhanced-locations-delivery-split-fulfillment).
Why are my orders not importing from Shopify?
The most common causes are:
- **Status filter mismatch** — Check that the Shopify order status (Classic) or financial status (Enhanced) matches your import settings at **Settings > Integrations > Shopify Settings**.
- **Location or delivery method filter** — In Enhanced, check that the fulfillment order's assigned location and delivery method are selected in your settings.
- **Excluded tag or import rule** — Check **Settings > Integrations > Shopify > Advanced** for excluded tags, and **Settings > Rules** for any no-import rules.
- **Checkout-rates-only mode** — If this is enabled, no orders will import through this integration.
For a full diagnostic, see [Troubleshoot: Shopify orders not importing](/articles/troubleshooting/integrations/shopify-troubleshooting-import).
Why did my local pickup order not import?
If you are using **Shopify Classic**, local pickup orders may not import because Classic requires a shipping address and pickup orders often do not have one.
Switch to **Shopify Enhanced**, which supports Local Pick Up orders without a shipping address. Enhanced can use your Starshipit sender address or the Shopify assigned pickup location address as a fallback.
See [Shopify Enhanced: locations, delivery methods, and split fulfillment](/articles/integrations/shopify/shopify-enhanced-locations-delivery-split-fulfillment#local-pickup-orders).
Why are pickup orders importing when I selected only Shipping?
Shopify does not always include delivery method data on every fulfillment order. Starshipit treats fulfillment orders without delivery method data as **Shipping**. This means some pickup orders may still import even if only Shipping is selected.
To prevent this, create an import rule that matches a reliable Shopify tag or shipping description on those orders and sets **Import order** to **False**.
When do orders from Shopify appear in Starshipit?
If **webhooks** are enabled under **Settings > Integrations > Shopify Settings**, eligible orders appear in near real time as soon as they are created or updated in Shopify.
Without webhooks, orders import on the scheduled cycle, which runs approximately every 20 minutes.
To subscribe to webhooks: go to **Settings > Integrations > Shopify Settings**, scroll to the bottom, and click **Subscribe to webhook**.
If I update an order in Shopify, will the change appear in Starshipit?
Yes, if webhooks are enabled. Changes to eligible orders in Shopify are pushed to Starshipit in near real time and the order is re-imported with the updated details.
Can Starshipit write back partial fulfillment to Shopify?
Yes, with **Shopify Enhanced**. Enhanced writeback targets the specific fulfillment order and can include individual fulfillment order line items, so you can mark only some items as fulfilled in Shopify.
This requires Shopify Enhanced to be the active version. Classic writeback does not support partial fulfillment at the line-item level.
Will Starshipit update my orders in Shopify to say they are fulfilled?
Yes. After a label is created (or after manifesting, if that option is enabled), Starshipit sends tracking details to Shopify and marks the order or fulfillment order as fulfilled. Shopify can then send its own shipping notification to the customer.
See [Write back tracking and fulfillment to Shopify](/articles/integrations/shopify/shopify-writeback) for full details and options.
My customers are receiving duplicate shipping emails. How do I stop this?
This usually happens when both Starshipit and Shopify are sending a "shipped" notification for the same event. To stop Shopify sending its own notification when Starshipit writes back:
1. Go to **Settings > Integrations > Shopify > Advanced tab**.
2. Enable **Disable Shopify customer notification**.
See [Write back tracking and fulfillment to Shopify](/articles/integrations/shopify/shopify-writeback#customer-notifications).
Can Starshipit tell Shopify when an order has been delivered?
Yes. Enable **Enable fulfillment event writeback** under **Settings > Integrations > Shopify > Advanced**. Starshipit will then send transit status updates (such as "Out for delivery" and "Delivered") back to Shopify as they are received from the carrier.
You also need to enable the corresponding shipping notification emails in your Shopify admin under **Settings > Notifications > Shipping**.
See [Write back tracking and fulfillment to Shopify](/articles/integrations/shopify/shopify-writeback#transit-status).
Can I use Shopify only for checkout rates and not import orders?
Yes. Enable **Use for checkout rates only** in your Shopify integration settings. When this is on, Starshipit returns live shipping rates to Shopify checkout but does not import any orders.
See [Shopify: Rates at checkout](/articles/rates-at-checkout/platform-specific-guides/shopify-rates-at-checkout).
Why are Shopify rates not showing at checkout?
Check that Shopify third-party carrier-calculated shipping is enabled, Starshipit is added to the relevant Shopify shipping zone as **Starshipit (Rates provided by app)**, **Delivery Options** is enabled in Starshipit, and the required carrier services are enabled under **Settings > Checkout Rates > Carrier Configuration**.
Also check that your Shopify products have weights. Shopify sends weight to Starshipit for live rates. Shopify Product or Product Variant dimension metafields apply to imported orders in Starshipit, but are not looked up during checkout-rate requests. To use item dimensions at checkout, set them up in the Product Catalogue and enable **Use on checkout**.
See [Shopify: Rates at checkout](/articles/rates-at-checkout/platform-specific-guides/shopify-rates-at-checkout#rates-not-showing-at-checkout).
What Shopify plan do I need to use live rates at checkout?
Shopify carrier-calculated shipping is available on **Advanced** and **Plus** plans. Shopify Grow stores can add it for an additional monthly fee or by switching to annual billing. Because Shopify controls these requirements and they can change, check [Shopify's current documentation](https://help.shopify.com/en/manual/fulfillment/setup/shipping-rates/third-party-carrier-calculated-shipping) for the latest plan eligibility.
Why was I redirected to Shopify when changing my Starshipit plan?
Some Starshipit accounts are billed through Shopify. If your account is Shopify-billed, plan changes may redirect you to Shopify so you can review and approve the billing change.
See [Shopify billing and subscription FAQ](/articles/integrations/shopify/shopify-billing-subscription-faq).
Can I import Shopify bundles?
Yes. Enable **Expand bundle products on import** under **Settings > Integrations > Shopify > Advanced > Field Mapping**. Most common Shopify bundling apps are supported, including the native Shopify Bundles app. Test your specific bundle app before relying on it in production.
See [Import optional data from Shopify](/articles/integrations/shopify/shopify-import-optional-data#bundle-products).
Can I import product dimensions from Shopify?
Yes. Starshipit can import length, width, and height from Shopify Product or Product Variant metafields. Enable **Import product dimensions metafields** under **Settings > Integrations > Shopify > Advanced**, then use supported metafield keys such as `shipping_length`, `length`, `shipping_width`, `width`, `shipping_height`, or `height`.
These dimensions are added to imported Shopify orders in Starshipit. They are not looked up during Shopify checkout-rate requests.
See [Import optional data from Shopify](/articles/integrations/shopify/shopify-import-optional-data#product-dimensions-metafields).
Can Starshipit import Shopify bin locations?
Yes. Starshipit can import bin locations from Shopify product or variant metafields. Use the Shopify metafield namespace and key `custom.bin_location`, then enable **Import Bin Location metafield** in **Settings > Integrations > Shopify > Advanced**.
See [Import optional data from Shopify](/articles/integrations/shopify/shopify-import-optional-data#bin-location-metafield).
I am using multiple locations in Shopify. How does this work in Starshipit?
Use **Shopify Enhanced** with Starshipit [child accounts](/articles/360000553016). Create one child account per Shopify location, connect the Enhanced integration in each, and select the matching Shopify location in each account's settings. Only orders assigned to that location will import into that account.
See [Shopify Enhanced: locations, delivery methods, and split fulfillment](/articles/integrations/shopify/shopify-enhanced-locations-delivery-split-fulfillment#multi-location-setup-with-child-accounts).
---
# Shopify integration overview
URL: https://support.starshipit.com/articles/90200000000201-shopify-integration-overview
Canonical: https://support.starshipit.com/articles/90200000000201-shopify-integration-overview
Markdown: https://support.starshipit.com/articles/90200000000201-shopify-integration-overview.md
Updated: 2026-05-27
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> An overview of the Starshipit Shopify integration: what it does, how Classic and Enhanced differ, and where to find the right guide for your setup.
Starshipit's Shopify integration connects your Shopify store to Starshipit so you can import orders, print labels, and send tracking updates back to Shopify automatically. You can connect as many Shopify stores as you need.
The integration has two versions: **Shopify Classic** and **Shopify Enhanced**. Classic imports Shopify orders; Enhanced imports Shopify fulfilment orders. This affects how orders import, which filters are available, and how writeback works.
## How Classic and Enhanced differ
Classic usually creates one Starshipit shipment from one Shopify order. Enhanced can create more than one shipment when Shopify has split an order by location, delivery method, or fulfilment group.
## Which version should I use?
| Merchant scenario | Recommended version |
| --- | --- |
| New setup with no legacy dependency | Enhanced |
| Single-location store with an existing, working Classic setup | Classic can stay as-is |
| Multiple Shopify locations | Enhanced |
| Local pickup or local delivery orders | Enhanced |
| One Shopify order may ship from more than one location | Enhanced |
| Partial fulfillment or fulfillment-order-level writeback matters | Enhanced |
| Using Shopify only for checkout rates, not order import | Either, with checkout-rates-only enabled |
For more detail, see [Shopify Classic vs Enhanced: which should I use?](/articles/integrations/shopify/shopify-classic-vs-enhanced).
## What the integration does
The Shopify integration covers three separate jobs. Most merchants use all three, but they can be configured independently.
**Order import** — Starshipit pulls eligible orders from Shopify and creates shipments automatically. Import runs on a schedule and can also be triggered in real time via Shopify webhooks.
**Writeback** — After a label is created or an order is manifested, Starshipit sends tracking details back to Shopify and marks the order or fulfillment order as fulfilled. Shopify can then notify your customer.
**Checkout rates** — Starshipit returns live shipping rates to Shopify checkout so customers can choose a courier and service at the time they place their order. This requires a Shopify plan that supports third-party carrier-calculated shipping.
## Article index
### Set up
- [Connect Shopify to Starshipit](/articles/integrations/shopify/connect-shopify-to-starshipit) — OAuth connection, choosing your version, and reauthorising
- [Shopify Classic vs Enhanced: which should I use?](/articles/integrations/shopify/shopify-classic-vs-enhanced) — Full comparison and decision guidance
### Configure
- [Configure Shopify order import](/articles/integrations/shopify/configure-shopify-order-import) — Status filters, locations, delivery methods, webhooks, and checkout-rates-only mode
- [Shopify Enhanced: locations, delivery methods, and split fulfillment](/articles/integrations/shopify/shopify-enhanced-locations-delivery-split-fulfillment) — Multi-location setup, local pickup, and how one Shopify order becomes multiple shipments
- [Import optional data from Shopify](/articles/integrations/shopify/shopify-import-optional-data) — Tags, order notes, shipping line items, metafields, bundles, and more
### Writeback and notifications
- [Write back tracking and fulfillment to Shopify](/articles/integrations/shopify/shopify-writeback) — All writeback settings, customer notifications, Classic tag/note writeback, Enhanced fulfillment-order writeback, and transit status
- [Shopify billing and subscription FAQ](/articles/integrations/shopify/shopify-billing-subscription-faq) — Shopify-billed accounts, plan changes, store changes, and child account questions
### Checkout rates
- [Shopify: Rates at checkout](/articles/rates-at-checkout/platform-specific-guides/shopify-rates-at-checkout) — Live rate setup, Shopify plan requirements, and carrier configuration
### Troubleshoot
- [Troubleshoot: Shopify orders not importing](/articles/troubleshooting/integrations/shopify-troubleshooting-import) — Step-by-step diagnostic for missing orders
- [Troubleshoot: Shopify writeback errors](/articles/troubleshooting/integrations/shopify-troubleshooting-writeback) — Writeback and fulfillment errors
## Most common Shopify problems
- [Orders not importing](/articles/troubleshooting/integrations/shopify-troubleshooting-import)
- [Rates not showing at checkout](/articles/rates-at-checkout/platform-specific-guides/shopify-rates-at-checkout#rates-not-showing-at-checkout)
- [Writeback or tracking not updating Shopify](/articles/troubleshooting/integrations/shopify-troubleshooting-writeback)
- [Shopify billing and subscription questions](/articles/integrations/shopify/shopify-billing-subscription-faq)
- [Metafields, bundles, and optional data](/articles/integrations/shopify/shopify-import-optional-data)
### Other Shopify guides
- [Actions from within Shopify](/articles/integrations/common-questions-and-how-to-guides/actions-from-within-shopify) — Generating labels from within your Shopify admin
- [Shopify: Manage pre-orders](/articles/integrations/common-questions-and-how-to-guides/shopify-manage-pre-orders) — Excluding pre-orders and back-orders from import using tags
- [How to add Authority to Leave and Signature Required to your Shopify checkout](/articles/integrations/common-questions-and-how-to-guides/how-to-add-authority-to-leave-and-signature-required-options-to-your-shopify-checkout)
---
# Shopify billing and subscription FAQ
URL: https://support.starshipit.com/articles/90200000000211-shopify-billing-and-subscription-faq
Canonical: https://support.starshipit.com/articles/90200000000211-shopify-billing-and-subscription-faq
Markdown: https://support.starshipit.com/articles/90200000000211-shopify-billing-and-subscription-faq.md
Updated: 2026-05-28
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Answers to common billing and subscription questions for Starshipit accounts billed through Shopify.
Some Starshipit accounts are billed through Shopify instead of being billed directly by Starshipit. This can affect where you approve plan changes and who needs to help if the Shopify billing connection changes.
## How do I know if my account is billed through Shopify?
If your account is Shopify-billed, plan changes may redirect you to Shopify so you can review and approve the billing change in your Shopify admin.
## Why did Starshipit send me to Shopify when changing plan?
Shopify requires merchants to approve billing changes for Shopify-billed apps. When you change your Starshipit plan, you may be redirected to Shopify to approve the updated subscription before the change can be completed.
## What if my Shopify billing store changes or is disconnected?
If the Shopify store linked to billing changes, is disconnected, or is no longer accessible, contact [Starshipit support](https://help.starshipit.com). Billing and account settings may need to be checked before plan changes can be completed.
## Can Shopify-billed accounts use child accounts or 3PL workflows?
Child account and 3PL workflows can differ when your Starshipit subscription is billed through Shopify. If you need child accounts while Shopify-billed, contact [Starshipit support](https://help.starshipit.com) so the team can confirm the best setup for your account.
---
# Shopify Classic vs Enhanced: which should I use?
URL: https://support.starshipit.com/articles/90200000000203-shopify-classic-vs-enhanced-which-should-i-use
Canonical: https://support.starshipit.com/articles/90200000000203-shopify-classic-vs-enhanced-which-should-i-use
Markdown: https://support.starshipit.com/articles/90200000000203-shopify-classic-vs-enhanced-which-should-i-use.md
Updated: 2026-06-24
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Understand the difference between Shopify Classic and Shopify Enhanced, and choose the right version for your store.
Starshipit's Shopify integration has two versions: **Shopify Classic** and **Shopify Enhanced**. They connect to the same Shopify store, but they work differently, and that difference affects import behaviour, filter options, local pickup support, and how writeback happens.
## The core difference
**Shopify Classic** is order-based. It imports each Shopify order as a single Starshipit shipment.
**Shopify Enhanced** is fulfillment-order-based. Shopify internally splits orders into fulfillment orders — one per location or fulfillment group — and Starshipit imports each fulfillment order as its own shipment. This means one Shopify order can become two or more Starshipit shipments.
That single difference explains most of the variation in how the two versions behave.
## Which version should I use?
| Scenario | Recommended version | Why |
| -------- | ------------------- | --- |
| New setup with no existing Classic workflow | **Enhanced** | Follows Shopify's fulfillment model; more flexible for modern workflows. |
| Existing Classic setup that is working well | Classic is fine to keep | No benefit to switching if your workflow does not need Enhanced features. |
| Multiple Shopify locations | **Enhanced** | Import can be filtered by the Shopify assigned fulfillment location. |
| Local pickup or local delivery orders | **Enhanced** | Can import pickup orders without a shipping address. Classic requires a shipping address. |
| One order may ship from more than one location | **Enhanced** | Shopify can split the order into fulfillment orders; Starshipit creates a separate shipment for each. |
| Partial fulfillment writeback | **Enhanced** | Writeback targets the specific fulfillment order and can specify individual line items. |
| Using Shopify only for checkout rates | Either | Enable checkout-rates-only; order import is disabled regardless of version. |
## Full comparison
| Area | Classic | Enhanced |
| ---- | ------- | -------- |
| Import model | Shopify order | Shopify fulfillment order |
| Shipments per Shopify order | One (usually) | One or more |
| Split fulfillment support | Limited | Supported |
| Import identifier | Shopify order ID | Shopify fulfillment order ID |
| Status filter | Order status (Open, Paid, Closed, Cancelled, Any, Partially Refunded) | Financial status (Authorized, Pending, Paid, Partially Paid, Refunded, Voided, Partially Refunded, Any, Unpaid) |
| Location filter | A single fulfillment location for writeback | Filter by Shopify assigned fulfillment location |
| Delivery method filter | Not available | Shipping, Local Delivery, Local Pick Up |
| Local pickup without address | Not supported | Supported — uses sender or assigned location address |
| Writeback target | Parent Shopify order | The imported fulfillment order |
| Partial fulfillment writeback | Not available | Supported — can specify fulfillment order line items |
| Webhooks | On Create and Update | On Create and Update |
## What happens when you switch
If you switch between Classic and Enhanced on an existing integration:
* The **webhook subscription** may be replaced. Resave your settings and resubscribe to webhooks after switching.
* **Order references** will change format for new imports. Enhanced appends a suffix when one Shopify order produces multiple Starshipit shipments (for example, `#1001-1` and `#1001-2`). Existing Starshipit orders are not affected.
* **Import filters** change. Location and delivery method filters are only available in Enhanced. Classic order status and Enhanced financial status are different fields — review your import settings after switching.
* Orders already in Starshipit are unaffected by the switch.
:::warning
Switching from Classic to Enhanced (or back) changes how future orders are identified and imported. Test with a small batch of orders before relying on the new version fully.
:::
---
# Import optional data from Shopify
URL: https://support.starshipit.com/articles/90200000000206-import-optional-data-from-shopify
Canonical: https://support.starshipit.com/articles/90200000000206-import-optional-data-from-shopify
Markdown: https://support.starshipit.com/articles/90200000000206-import-optional-data-from-shopify.md
Updated: 2026-09-03
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Configure which additional data Starshipit imports from Shopify, including tags, order notes, shipping line items, metafields, and bundles.
Starshipit can import extra data alongside your Shopify orders. All optional import settings are found under **Settings > Integrations > Shopify > Advanced tab > Field Mapping section**, unless otherwise noted.
## Tags
Enable **Import Tags from Shopify** to bring Shopify order tags into Starshipit. Once imported, tags appear in the orders grid.
For more on using tags in Starshipit, see [Tags](/articles/orders-manifests-reports/orders/tags).
## Order notes
Choose how Shopify checkout notes are mapped when they import into Starshipit. Select from the **Map order notes** dropdown:
| Option | What it does |
| --- | --- |
| Do not import notes | Notes are discarded on import. |
| Map to delivery instructions | Notes appear in the Delivery Instructions field. Use this when notes contain delivery-specific information. |
| Map to notes section | Notes appear in the Notes field. Use this for personalisation, gift messages, or other non-delivery notes. |
| Map to both | Notes appear in both fields. |
:::note
The Notes section is available in UI 2.0 only.
:::
## Shipping as a line item
Enable **Import shipping as a line item** to add the Shopify shipping charge as a line item named `Shipping` on each imported order.
When a Shopify Enhanced order is split into multiple Starshipit shipments, the shipping cost is proportionally allocated across each shipment based on item value.
**Example:** A customer pays $10 shipping. The order splits into two fulfillments: one worth $50 and one worth $150. The $50 shipment gets $2.50 in shipping; the $150 shipment gets $7.50.
This can help when a carrier or customs workflow needs the freight charge from Shopify included as an order line, such as DHL shipments where the commercial invoice needs to show the shipping charge. If Shopify applied free shipping, a discount, or a minimum shipping charge, Starshipit imports the final shipping amount supplied by Shopify.
## Item quantity vs fulfillable quantity
By default, Starshipit imports the **fulfillable quantity** of each line item — the quantity Shopify considers ready to fulfill. This is the safer default, especially in Enhanced where items can be split across fulfillment orders.
Enable **Import item quantity instead of fulfillable quantity** if you need the total ordered quantity regardless of fulfillment state. Only use this if you are certain it matches your workflow.
## Bin location metafield
Starshipit can import bin location data from a Shopify product or product variant metafield to help with pick and pack.
This setting is available in **Shopify Enhanced** only. If you use Shopify Classic, use the [Product Catalogue](/articles/integrations/product-catalogue/product-catalogue) to manage bin locations instead.
**Setup in Shopify:**
1. Create a [new custom text metafield](https://help.shopify.com/en/manual/metafields/metafield-definitions/creating-custom-metafield-definitions) in Shopify.
2. Set the namespace and key to:
```
custom.bin_location
```
3. Add values to each relevant product or variant.
**Setup in Starshipit:**
1. Go to **Settings > Integrations > Shopify > Advanced**.
2. Enable **Import Bin Location metafield**.
3. Select whether the metafield is on the **product** or the **variant**.
4. Click **Save**.
Bin locations will appear on imported orders.
## Product dimensions metafields
Starshipit can import length, width, and height from Shopify Product or Product Variant metafields. These dimensions are added to imported order items and can be used by packaging settings such as **Unique Package for each item** and **Recommended Packaging**.
:::note
Shopify product dimension metafields are used when orders import into Starshipit. They are not looked up during Shopify live checkout-rate requests. To use item dimensions at checkout, configure Product Catalogue dimensions and enable **Use on checkout**.
:::
Recommended Packaging requires the Professional plan.
1. In Starshipit, go to **Settings > Integrations > Shopify > Advanced**.
2. Enable **Import product dimensions metafields**.
3. Choose whether the metafields are on the **product** or **variant**.
4. Select the **Dimension unit for numeric metafields**: cm, mm, in, or m.
5. In Shopify, create metafields using the supported keys below.
6. Add values to each relevant product or variant.
7. Save your Shopify settings in Starshipit.
| Dimension | Supported metafield keys |
| --- | --- |
| Length | `shipping_length`, `length` |
| Width | `shipping_width`, `width` |
| Height | `shipping_height`, `height` |
Raw numeric metafields use the dimension unit selected in Starshipit. Shopify dimension metafields with their own unit use the Shopify unit instead.
Use Shopify **Number (decimal)** metafields when a dimension needs a fractional value, such as `12.5`. **Number (integer)** metafields are also supported for whole-number values. Do not enter units in a numeric metafield; choose the unit in Starshipit or use Shopify's dimension metafield type instead.
Invalid or missing values are ignored. Changes apply to newly imported orders. To update existing orders, remove and re-import them.
## Customs item descriptions
Starshipit can import customs item descriptions from a Shopify product custom field. This is useful for international shipments.
**Setup in Shopify:**
1. Create a custom field on the product using the namespace and key:
```
custom.customs_description
```
2. Add a value to each relevant product.
No additional setup is required in Starshipit. The customs description imports automatically when those products are included in a shipment.
## Country-specific tax IDs
Enable this setting to import destination tax identifiers from Shopify's localized order fields — for example, CPF/CNPJ for Brazil or RFC for Mexico. Starshipit uses these on international shipments where required.
## Country-specific HS codes
When enabled, Starshipit prefers country-specific HS codes from Shopify inventory item data, if available. If a country-specific code is not found, it falls back to the generic HS code on the product.
## DHL service point metafield
Enable this setting to import the DHL service point ID from the `delivery.service_point_id` metafield on the Shopify order. This setting triggers an additional Shopify API call per order.
Only enable this if you use DHL with service point delivery. Do not enable it for general use.
## Product variants as item descriptions
Enable **Map the name of product variants for order item descriptions** to use Shopify variant names as the line item description in Starshipit. This is useful for pick and pack when your products have multiple variants (size, colour, etc.).
Changes apply to newly imported orders. To update existing orders, remove and re-import them.
## Bundle products
Shopify bundle products are typically imported as a single line item with item properties listing the individual components. To split bundles into separate line items:
1. Go to **Settings > Integrations > Shopify > Advanced > Field Mapping**.
2. Enable **Expand bundle products on import**.
**Shopify bundle apps:** Starshipit supports most common Shopify bundling apps, including the native [Shopify Bundles](https://apps.shopify.com/shopify-bundles) app. Bundle configurations vary between apps, so test compatibility with your specific app before relying on it in production.
## Product Catalogue and Shopify
Shopify sends Starshipit the order and product data available on the imported order, such as SKU, title or item name, variant details, barcode, weight, and available customs fields such as HS code or country of origin.
The Starshipit [Product Catalogue](/articles/integrations/product-catalogue/product-catalogue) can enrich imported Shopify orders when the SKU on the order item matches a SKU in the catalogue. Depending on your Product Catalogue settings, Starshipit can fill or improve values such as:
- Package matching
- Customs fields
- Bin location
- Missing or corrected weights and dimensions
- Checkout-rate package selection
The Product Catalogue is especially useful for Shopify checkout rates because Shopify live-rate requests are weight-first. When Starshipit can match cart items to catalogue products, it can use your saved catalogue data before returning rates to Shopify.
If you already manage item dimensions in Shopify, you can also import dimensions from Shopify Product or Product Variant metafields onto imported orders using the setup above.
---
# Write back tracking and fulfilment to Shopify
URL: https://support.starshipit.com/articles/90200000000207-write-back-tracking-and-fulfilment-to-shopify
Canonical: https://support.starshipit.com/articles/90200000000207-write-back-tracking-and-fulfilment-to-shopify
Markdown: https://support.starshipit.com/articles/90200000000207-write-back-tracking-and-fulfilment-to-shopify.md
Updated: 2026-05-27
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Configure how Starshipit sends tracking details and fulfillment updates back to Shopify, including customer notifications, Classic writeback, Enhanced writeback, partial fulfillment, and transit status.
Writeback is the process of Starshipit sending information back to Shopify after a label is created or an order is manifested. This typically marks the Shopify order or fulfillment order as fulfilled and provides the customer's tracking number.
All writeback settings are found at **Settings > Integrations > Shopify Settings** (main tab and Advanced tab).
## When writeback fires
By default, writeback happens when a label is created in Starshipit.
To trigger writeback on manifest instead:
1. Go to **Settings > Integrations > Shopify**.
2. Enable **Write back order updates on manifest**.
Both options update Shopify at the same point — the difference is when in your workflow it happens.
## Disable writeback entirely
If you do not want Starshipit to update Shopify at all:
1. Go to **Settings > Integrations > Shopify > Advanced tab**.
2. Enable **Disable Writeback**.
When this is on, Starshipit will not send any tracking or fulfillment updates to Shopify. Customer notifications from Shopify will also not fire.
## Customer notifications {#customer-notifications}
By default, when Starshipit writes back to Shopify, Shopify sends its own shipping notification email to the customer.
If you send your own tracking emails from Starshipit (or another system), you may want to prevent Shopify from sending a duplicate email.
To disable Shopify customer notifications:
1. Go to **Settings > Integrations > Shopify > Advanced tab**.
2. In the **Writeback** section, enable **Disable Shopify customer notification**.
3. Click **Save**.
Writeback will still update the Shopify order status and tracking number — customers just will not receive the Shopify email.
:::note
Fulfillment event writeback (transit status) requires both writeback and Shopify customer notifications to be enabled. If you disable customer notifications, transit status writeback will not function.
:::
## Classic writeback
In Shopify Classic, Starshipit can write back in two ways: tag/note writeback and fulfillment writeback.
### Tag and note writeback
Starshipit can append information to the Shopify order without creating a Shopify fulfillment. This is useful when a third-party fulfillment service manages fulfillment in Shopify, and you only want Starshipit to mark the order on the Shopify order record.
- **Order tag writeback** — Appends a tag to the Shopify order. The default tag value is `SHIPPED`.
- **Note attribute writeback** — Appends carrier tracking details to the Shopify order's note attributes.
Both options are in **Settings > Integrations > Shopify > Advanced > Writeback**.
:::important
If tag/note writeback is enabled alongside fulfillment writeback, Shopify may receive duplicate updates. Use the option below to prevent this.
:::
### Skip fulfillment creation after tag and note writeback
Enable **Do not create Shopify fulfillments after tag and note writeback** when a third-party fulfillment service will complete the Shopify fulfillment, and you only want Starshipit to tag or note the order.
Only enable this setting if another service owns the Shopify fulfillment. If Starshipit is your primary fulfillment tool, leave this off.
### Fulfillment writeback
For most Classic merchants, Starshipit creates a Shopify fulfillment record with the tracking number and carrier, and marks the order as fulfilled. This works for open or in-progress Shopify fulfillment orders.
## Enhanced writeback
In Shopify Enhanced, writeback targets the specific Shopify **fulfillment order** that was imported into Starshipit. This is more precise than Classic writeback, especially for split or partially fulfilled orders.
Starshipit sends:
- The tracking number
- The tracking URL
- The tracking company (carrier name)
The writeback creates a Shopify fulfillment against the fulfillment order ID that was stored when the order was imported.
### Partial fulfillment
Enhanced writeback can specify individual fulfillment order line items and quantities, enabling Starshipit to fulfill only part of a fulfillment order.
This allows for scenarios where:
- Only some items in a fulfillment order are ready to ship.
- You are fulfilling items in batches.
:::note
Enhanced writeback does not write back return jobs. Returns are a separate workflow.
:::
## Ready for pickup {#pickup-ready-for-pickup}
For Local Pick Up orders, Starshipit can mark the Shopify fulfillment order as **ready for pickup** instead of creating a standard shipping fulfillment.
To enable: go to **Settings > Integrations > Shopify > Advanced** and enable **Mark pickup fulfillment orders as ready for pickup**.
When this is on, processing a pickup order in Starshipit sends the "ready for pickup" status to Shopify, which can trigger Shopify's own pickup notification to the customer.
## Transit status writeback (fulfillment event writeback) {#transit-status}
By default, Starshipit writes back once — when the order is shipped. You can optionally enable **fulfillment event writeback** so that additional transit statuses (such as "Out for delivery" and "Delivered") are also sent back to Shopify as the package moves through the carrier network.
**Requirements:**
- Writeback must be enabled.
- Shopify customer notifications must be enabled (not disabled).
- The Starshipit account must have the fulfillment event writeback feature available.
**To enable:**
1. Go to **Settings > Integrations > Shopify > Advanced tab**.
2. Enable **Enable fulfillment event writeback**.
3. Click **Save**.
**Configure Shopify shipping notifications:**
After enabling in Starshipit, you also need to turn on the relevant shipping status emails in Shopify:
1. In your Shopify admin, go to **Settings > Notifications**.
2. Scroll to the **Shipping** section.
3. Enable the notification types you want customers to receive, such as **Out for delivery** and **Delivered**.
:::note
Most merchants only need a single "your order has shipped" email. Only enable fulfillment event writeback if you want Shopify to send status-by-status updates to customers. If Starshipit is already sending those emails, enabling this as well will create duplicates.
:::
## Tracking URL defaults to Google or shows incorrectly in Shopify
If a carrier is not recognised by Shopify, it falls back to a Google search URL or shows no tracking link. To fix this, update the shipping confirmation email template in Shopify to use the tracking URL provided by Starshipit directly. See [Shopify's help documentation](https://help.shopify.com/en/manual/fulfillment/fulfilling-orders) for template editing guidance.
---
# Actions from within Shopify
URL: https://support.starshipit.com/articles/115000718963-actions-from-within-shopify
Canonical: https://support.starshipit.com/articles/115000718963-actions-from-within-shopify
Markdown: https://support.starshipit.com/articles/115000718963-actions-from-within-shopify.md
Updated: 2026-05-06
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Use the Starshipit Shopify app to generate shipping labels directly from your Shopify admin panel.
Use the [Starshipit Shopify app](https://apps.shopify.com/starshipit) to generate your shipping labels directly from within your Shopify admin panel.
## Before you begin
* The [Starshipit Shopify App](https://apps.shopify.com/starshipit) must be installed on your Shopify store.
* Your [courier companies](/categories/couriers) must be integrated with your Starshipit account.
* You must be logged into the [Starshipit App](https://app.starshipit.com/Account/MemberLogin.aspx?ReturnUrl=%2f%3f_ga%3d2.83077590.1963362540.1567980059-37912989.1556581310).
## Generate a label from a Shopify order
1. Log in to your Shopify admin panel
2. Go to the **Orders** panel
3. Open the order you would like to print
4. Click on **Apps** > **Starshipit Print Labels**
## Create Shipment
On the **Ship Order** page, all the information relative to your shipments is displayed. The **Weight** is automatically calculated from Shopify and the delivery service and options are set up according to your Starshipit account. All this information is editable. When you are ready, click **Create Shipment** and the label will be automatically generated.
## Download your labels
As soon the **Create Shipment** is clicked a link with the date and the label will be displayed. Click on **Download Label** and the PDF of the label will be downloaded to your computer.
## International orders
For international orders, Starshipit will automatically generate the invoice or CN22 for you. Starshipit offers two options for generating these documents:
* Use **Line Item Description** - Starshipit will use the product description from Shopify
* Use **Generic Item Descriptions** - Starshipit will use the generic description from **Settings** *>* **Option** *>* **Package Description**.
:::note
Your last choice will be remembered as the default for the next shipment.
:::
## Bulk Print labels
2. Click on **Bulk actions** > **Print Starshipit Labels**
## Bulk Print labels
1. Select the orders you want to print
2. Click on **Bulk actions** > **Print Starshipit Labels**
3. You can edit the delivery service and delivery options for the selected orders
4. Click on **Create Shipment**
5. A label will be generated for all the orders previously selected the labels can be downloaded under **BULK SHIPMENT LABELS**.
---
# Manage Shopify pre-orders
URL: https://support.starshipit.com/articles/360000117335-manage-shopify-pre-orders
Canonical: https://support.starshipit.com/articles/360000117335-manage-shopify-pre-orders
Markdown: https://support.starshipit.com/articles/360000117335-manage-shopify-pre-orders.md
Updated: 2026-05-06
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Prevent pre-orders from importing into Starshipit by tagging them in Shopify while keeping them unfulfilled.
This is useful if you have some orders that are pre-orders or on back order, and you wish to keep the status as unfulfilled or open. Orders import into Starshipit based on the status that you set in the Shopify settings.
## Set up
The following steps will guide you on how to prevent pre-orders from being imported into Shopify while maintaining their unfulfilled status. You can achieve this by adding one or more tags to the orders.
#### 1. In Starshipit, set up the tags to be used to exclude orders
1. Go to **Settings** > **Integrations**, > **Shopify.**
2. Click the **Advanced** tab.
3. In the **Exclude orders with these tags** field, enter the tags that you will use on Shopify orders to stop them from importing. In this example, we will use **preorder**.
#### 2. Add a pre-order tag to the order in Shopify
1. Open the order in Shopify.
2. Navigate down to the **Tags** **section.**
3. Add the **preorder** tag.
4. Now when you run an import in Starshipit, the tagged order will not import.
:::warning
NoteYou must tag the order itself, not the items in the order.
:::
#### 3. Removing the pre-order tag for when you want to import
1. Open the order in Shopify.
2. Navigate down to the **Tags** **section.**
3. Remove the preorder tag.
4. When you run an import in Starshipit, the order will now import.
:::warning
NoteBe sure to run an import back to the date the order was placed. e.g. if the order was placed 20 days ago then you should run an import for 20-21 days.
:::
#### 4. Removing multiple pre-order tags
1. Open the **Orders** page in Shopify.
2. Next to the search bar, select **Filters** **> Select a Filter > Tagged with.**
3. Select the pre-order tag you used and click **Add Filter.**
4. In the results, select the orders you'd like to remove the pre-order tags from and then select **Actions > Remove Tags.**
5. Be sure to select the preorder tag to be removed from the list of existing tags.
6. Click **Apply changes.**
7. Your orders can now be imported.
:::warning
NoteBe sure to run an import back to the date the order was placed. e.g. if the order was placed 20 days ago then you should run an import for 20-21 days.
:::
---
# Troubleshoot Shopify
URL: https://support.starshipit.com/articles/360000921776-troubleshoot-shopify
Canonical: https://support.starshipit.com/articles/360000921776-troubleshoot-shopify
Markdown: https://support.starshipit.com/articles/360000921776-troubleshoot-shopify.md
Updated: 2026-05-27
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Learn how to troubleshoot and resolve common issues with the Shopify integration.
This article has been replaced by two focused troubleshooting guides:
- **[Troubleshoot: Shopify orders not importing](/articles/troubleshooting/integrations/shopify-troubleshooting-import)** — Orders that are missing or not appearing in Starshipit
- **[Troubleshoot: Shopify writeback errors](/articles/troubleshooting/integrations/shopify-troubleshooting-writeback)** — Errors when Starshipit tries to update Shopify with tracking or fulfillment details
For setup instructions, see [how to integrate with Shopify](/articles/integrations/ecommerce-platforms/how-to-integrate-with-shopify).
## Before you begin
* Log out of your Shopify account before performing the troubleshooting steps below.
* Ensure you work out of a web browser, not within the Shopify window.
* If the issues persist, try using your web browser in Incognito/Private mode.
## Fulfilment location writeback error
The fulfilment location in Shopify is mandatory. When you fulfil your orders in Shopify, you must specify the location where orders will be be fulfilled. For example, if you have two shops in different cities ( ie Melbourne and Perth), you will need to specific if the order will be fulfilled in Melbourne or Perth. You also need to be sure that the selected location has the stock.
If you don't define a location in Starshipit settings, Starshipit will use the first location to fulfil your orders. However, this location might not have the required stock to fulfil your order. The order will not be updated in Shopify and StarShipIT will display a writeback error.
To resolve this you must follow the steps below to specify the fulfilment location in Starshipit:
1. In Starshipit, navigate to **Settings** > **Integrations**.
2. Click **Shopify Settings**.
3. Click **Lookup**, and select the location you want to use.
4. Click **Save**.
## Fulfillment order has been completed or closed writeback error
If you're seeing this error message, it could mean one of the following:
1. **Order Already Fulfilled**: The order has already been marked as fulfilled in Shopify, which means no further updates can be made.
2. **Third-Party Fulfillment**: The order is using a third-party fulfilment service that is not allowing Starshipit from updating the status.
To resolve this:
1. **Order Already Fulfilled**: Verify the order status in Shopify to ensure it hasn't already been fulfilled.
2. **Third-Party Fulfillment**: If you're using a third-party fulfilment service, you may need to manage the fulfilment status through that service.
If the issue persists, you might need to adjust your fulfillment settings or you can reach out to our [friendly support team](https://help.starshipit.com) for further assistance.
## Tracking URL defaults to Google
If you are using a carrier outside of the designated carrier list, Shopify will default the carrier type to 'Other' or leave the field blank.
For example, Shopify does not recognise **StarTrack** as carrier when the order is shipped by StarTrack in Starshipit. The carrier field in Shopify will default to 'Other' or be blank, and the tracking URL in the email notification from Shopify will be a Google website link.
To resolve this issue, you need to modify the Email Notification Template in your Shopify account. See the [Shopify help center](https://help.shopify.com/en/manual/fulfillment/fulfilling-orders#fulfill-orders-automatically) for more information on how to do this.
**Carrier Tracking URL:**
StarTrack:
CourierPost:
---
# Add 'Authority to Leave' and 'Signature Required' options to your Shopify checkout
URL: https://support.starshipit.com/articles/360000085216-add-authority-to-leave-and-signature-required-options-to-your-shopify-checkout
Canonical: https://support.starshipit.com/articles/360000085216-add-authority-to-leave-and-signature-required-options-to-your-shopify-checkout
Markdown: https://support.starshipit.com/articles/360000085216-add-authority-to-leave-and-signature-required-options-to-your-shopify-checkout.md
Updated: 2026-05-06
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Learn how to add 'authority to leave' and 'signature required' options to your Shopify checkout.
In this guide, we'll show you how to add 'Authority to Leave' and 'Signature Required' checkboxes to your Shopify checkout. This ensures that when you import orders into Starshipit, these delivery preferences will be automatically selected. Follow these steps to streamline your shipping process and enhance your customers' delivery experience.
## Modify the shopping cart page in Shopify
To add a checkbox to select 'Authority To Leave'/'Signature Required in your Shopify shopping cart, you first need to create a checkbox that your customer can select.
Checkout Extensibility checkout.liquid (deprecated)
:::note
Shopify plan requirements Per Shopifyseligibility requirementsyou must be on an a Shopify plus plan.
:::
We have introduced a new 'UI Extension' called 'Checkout Delivery Options' on our Shopify app. This extension allows you to customise the checkout process by adding specific delivery options directly to the checkout page.
1. [Ensure you have our Shopify app](/articles/integrations/common-questions-and-how-to-guides/actions-from-within-shopify) and then navigate to **Settings** > **Checkout** > **Customise**.
2. Scroll down and click on **'Add app block'** at the bottom of the page.
3. In the app block selection, you should see **'checkout-delivery-options'**. Select it.
4. The 'Checkout Delivery Options' extension has a settings page where you can choose to show any of the following options:
* **Authority to Leave (ATL)**
* **Signature Required**
5. You can rename these settings to anything you like. Rest assured, they will still send the correct attributes to Starshipit upon order import.
:::note
Shopify deprecation This method has since been deprecated by Shopify. If you were previously using this method, we recommendmigrating to checkout extensibility.
:::
Edit the Theme Code of Shopify and copy the custom code from Starshipit.
To learn how to edit the Theme Code, refer to the section "Add a form field to your theme code" of [this article](https://help.shopify.com/themes/customization/cart/get-more-information-with-cart-attributes) or you can follow the following steps.
1. On the Shopify admin page, go to **Online Store** > **Themes**.
2. Locate the theme you want to edit, and then click **Actions** > **Edit code**.
3. In the **Sections** area, click on **cart-template.liquid**. If your theme doesn't have a cart-template.liquid, then, in the Templates directory, click on **cart.liquid**.
4. Search for the last **subtotal** reference in the file, and then locate the closing tag.
5. On a new line right below the closing tag, paste the code below. You may need to experiment with putting the code in different places to ensure the field appears correctly on your cart page.
```
```
This is what it should look like when the code has been pasted:
You can modify the style of the checkbox, however, the name must be **Authority To Leave**. Otherwise, the information won't be imported into Starshipit.
## How this appears in Shopify
After you have added the Authority To Leave checkbox, you should see it on your shopping cart page and the order details page.
## How this appears in Starshipit
After you have added the checkbox to your Shopify shopping cart, your customer can select it during the checkout process. When orders are imported from Shopify to Starshipit, the option will be automatically selected in Starshipit.
---
# Troubleshoot Shopify orders not importing
URL: https://support.starshipit.com/articles/90200000000209-troubleshoot-shopify-orders-not-importing
Canonical: https://support.starshipit.com/articles/90200000000209-troubleshoot-shopify-orders-not-importing
Markdown: https://support.starshipit.com/articles/90200000000209-troubleshoot-shopify-orders-not-importing.md
Updated: 2026-05-27
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Diagnose and fix common reasons why Shopify orders are not appearing in Starshipit.
If a Shopify order is not appearing in Starshipit, work through the checks below in order. Each check addresses a specific reason orders are skipped.
For writeback errors (orders that import but do not update Shopify), see [Troubleshoot: Shopify writeback errors](/articles/troubleshooting/integrations/shopify-troubleshooting-writeback).
## Quick checklist
Common reasons a Shopify order does not import:
- **Use for checkout rates only** is enabled.
- The order does not match the selected Classic order status or Enhanced financial status.
- The order has an excluded Shopify tag.
- A Starshipit no-import rule applies.
- Fraud checking skipped the order because Shopify risk recommended cancellation.
- In Enhanced, the assigned Shopify location is not selected.
- In Enhanced, the delivery method is not selected.
- The Shopify order is cancelled or closed.
- The Shopify fulfillment order is on hold, closed, or cancelled.
- The fulfillment order was already imported.
- The webhook is not subscribed or the Shopify integration needs reauthorisation.
## Before you start
- Check that the order is not already in Starshipit by searching for the Shopify order number. In Shopify Enhanced, the order may have a suffix (for example, `#1001-1`).
- Check whether the order is in the **Dispatched** or **Archived** view in Starshipit — it may have already been processed.
- Make sure you are working in a web browser, not within the Shopify App. Log out of Shopify and log back in if you are unsure.
---
## 1. Check: is checkout-rates-only mode enabled?
Go to **Settings > Integrations > Shopify Settings** and check whether **Use for checkout rates only** is enabled.
If it is, order import is disabled for this integration. Turn it off to allow orders to import.
---
## 2. Check: does the order status match your import settings?
The status filter is the most common reason orders are skipped.
**Classic:** Go to **Settings > Integrations > Shopify Settings** and check the **Order Status** setting. The Shopify order's status must match this setting to import.
**Enhanced:** Check the **Order Financial Status** setting. The Shopify order's financial status must match. Note that fulfillment-order filters (location, delivery method) are applied after the financial status check passes.
If the order has a different status than expected, either update the order in Shopify or adjust the import setting.
Cancelled or closed Shopify orders may also be skipped, depending on your selected import settings and the fulfillment order state.
---
## 3. Check: is the order excluded by a tag or import rule? (Enhanced and Classic)
Go to **Settings > Integrations > Shopify > Advanced tab** and check the **Exclude orders with these tags** field.
If the Shopify order has any of those tags, it will not import. Remove the tag in Shopify or remove it from the exclusion list in Starshipit.
Also check **Settings > Rules** for any no-import rules that might match the order.
---
## 4. Check: is the assigned location included? (Enhanced only)
Go to **Settings > Integrations > Shopify Settings > Locations**.
If a specific location is selected, only fulfillment orders assigned to that Shopify location will import. If the order is assigned to a different location in Shopify, it will be skipped.
Change the location filter to **All Locations** or add the correct location.
If the locations list will not load, reauthorise the Shopify integration — this is a permissions issue.
---
## 5. Check: is the delivery method included? (Enhanced only)
Go to **Settings > Integrations > Shopify Settings > Delivery Methods**.
If a specific delivery method is not selected, fulfillment orders with that delivery method will be skipped. Confirm which delivery method the order has in Shopify and make sure that method is enabled in Starshipit.
:::note
Shopify does not always include delivery method data on every fulfillment order. Fulfillment orders without delivery method data are treated as **Shipping**. If a known pickup order keeps importing when only Shipping is selected, use an import rule to exclude it by tag or shipping description.
:::
---
## 6. Check: is fraud checking blocking the order?
If **Enable Fraud Check** is turned on (under **Settings > Integrations > Shopify > Advanced**), Starshipit skips orders where Shopify's risk analysis recommends cancellation.
To confirm: open the order in Shopify and review its risk details. If Shopify has flagged the order as high risk, either adjust the order in Shopify or disable fraud checking for this integration.
---
## 7. Check: does the order have a shipping address? (Classic)
Shopify Classic requires a shipping address to create a Starshipit shipment. Orders without a shipping address — including most local pickup orders — will not import.
If the order is a local pickup order, switch to **Shopify Enhanced**, which can import pickup orders without a shipping address. See [Shopify Enhanced: locations, delivery methods, and split fulfillment](/articles/integrations/shopify/shopify-enhanced-locations-delivery-split-fulfillment#local-pickup-orders).
---
## 8. Check: does the order contain shippable items?
Orders with no shippable items (for example, digital products only) will not import. Confirm the order includes at least one physical item.
---
## 9. Check: has the order already been imported or is it a duplicate?
Classic checks whether a Shopify order ID has already been imported. Enhanced checks whether the Shopify fulfillment order ID has already been imported.
Search Starshipit by the Shopify order number. In Enhanced, try with the suffix format (`#1001-1`). If the order is already there, it will not re-import unless you remove it and re-import manually.
Re-importing existing Shopify orders may not create duplicates because Starshipit checks whether the Shopify order ID (Classic) or fulfillment order ID (Enhanced) has already been imported.
If the order changed in Shopify after import and webhooks are enabled, eligible updates may be sent to Starshipit. The order still needs to pass your import filters and rules.
---
## 10. Check: is the order older than two days?
Starshipit automatically imports orders from the last two days. Orders older than two days must be imported manually.
To manually import an order: use the manual import option in **Settings > Integrations > Shopify Settings**, or re-open the order in Starshipit if it was previously archived.
---
## 11. Check: is the integration connected and active?
Go to **Settings > Integrations** and confirm that Starshipit shows a successful connection for Shopify. Click **Test** to verify.
Also confirm that **Automatically import orders from all integrations** is enabled.
If the connection test fails, reauthorise the Shopify integration.
---
## Scheduled import vs webhook import
Scheduled import runs approximately every 20 minutes.
Webhooks can push eligible Shopify order creates or updates to Starshipit in near real time. Webhooks require a saved Shopify integration.
If you switch between Classic and Enhanced, resave the Shopify settings and resubscribe to webhooks. The webhook subscription may be replaced when the integration version changes.
If locations, fulfillment orders, inventory, or webhook subscription actions fail, reauthorise Shopify and try again.
---
## Still not importing?
Use the **Troubleshooting import** tab within your Shopify integration settings in Starshipit. This shows import attempt logs and why specific orders were skipped.
If the issue persists, contact [Starshipit support](https://help.starshipit.com) with the Shopify order number and details of the checks above.
---
# Troubleshoot Shopify writeback errors
URL: https://support.starshipit.com/articles/90200000000210-troubleshoot-shopify-writeback-errors
Canonical: https://support.starshipit.com/articles/90200000000210-troubleshoot-shopify-writeback-errors
Markdown: https://support.starshipit.com/articles/90200000000210-troubleshoot-shopify-writeback-errors.md
Updated: 2026-05-27
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Diagnose and fix common errors when Starshipit fails to update fulfillment status or tracking in Shopify.
This article covers errors that appear when Starshipit tries to send tracking or fulfillment updates back to Shopify but fails. For orders that are not importing at all, see [Troubleshoot: Shopify orders not importing](/articles/troubleshooting/integrations/shopify-troubleshooting-import).
## Before you start
- Log out of your Shopify account before performing the steps below.
- Work from a web browser, not within the Shopify App window.
- If issues persist, try in an Incognito or Private browser window.
---
## Writeback is not firing at all
**Check 1: Is writeback disabled?**
Go to **Settings > Integrations > Shopify > Advanced tab** and confirm that **Disable Writeback** is not enabled. If it is, enable writeback and save.
**Check 2: Is the integration connected?**
Go to **Settings > Integrations** and click **Test** on the Shopify integration. If the test fails, reauthorise the Shopify integration and try again.
**Check 3: Does writeback fire on manifest instead of on label creation?**
If you have enabled **Write back order updates on manifest**, writeback only fires after you manifest your orders — not immediately when the label is printed. Check whether the order has been manifested.
---
## Fulfillment location writeback error
This error appears when Starshipit cannot fulfill the Shopify order because the selected location does not have stock allocated to it in Shopify.
Shopify requires a valid fulfillment location with stock. If Starshipit uses the wrong location, Shopify rejects the fulfillment.
**To resolve (Classic):**
1. Go to **Settings > Integrations > Shopify Settings**.
2. In the **Locations** field, click **Lookup** and select the correct Shopify location.
3. Click **Save**.
**To resolve (Enhanced):**
Enhanced writeback uses the Shopify assigned fulfillment location from when the order was imported. If that location has changed in Shopify, the writeback will fail. Open the order in Shopify and confirm which location holds the stock.
---
## "Fulfillment order has been completed or closed" error
This error means Starshipit attempted to create a fulfillment in Shopify, but the fulfillment order was already closed or completed.
**Likely causes:**
- **Order already fulfilled** — The order was marked as fulfilled in Shopify before Starshipit attempted writeback. No further updates can be made.
- **Third-party fulfillment service** — A third-party fulfillment service closed the fulfillment order before Starshipit wrote back.
**To resolve:**
1. Open the order in Shopify and confirm its current fulfillment status.
2. If the order was fulfilled by another service, you do not need to take action in Starshipit.
3. If the order should not have been closed, contact your Shopify admin or fulfillment service.
:::note
For Classic merchants using a third-party fulfillment service: consider enabling **Do not create Shopify fulfillments after tag and note writeback** so Starshipit only appends tags/notes instead of attempting to create fulfillments. See [Write back tracking and fulfillment to Shopify](/articles/integrations/shopify/shopify-writeback#classic-writeback).
:::
---
## Tracking URL defaults to Google or shows an incorrect link
This happens when Shopify does not recognise the carrier Starshipit used. Shopify defaults to a Google URL or leaves the tracking link blank.
This is a Shopify template issue, not a Starshipit error.
To fix it, update the shipping confirmation email template in your Shopify admin to use the tracking URL provided by Starshipit directly. See [Shopify's help documentation](https://help.shopify.com/en/manual/fulfillment/fulfilling-orders) for guidance on editing notification templates.
Common carrier tracking URL formats to use in Shopify templates:
- **StarTrack:** `http://www.startrack.com.au/track-trace/?id={{tracking_number}}`
- **CourierPost:** `http://trackandtrace.courierpost.co.nz/search/{{tracking_number}}`
Replace the static tracking number in the URL with the Shopify tracking number variable appropriate to your template.
---
## Customer did not receive a Shopify shipping notification
**Check 1: Is customer notification disabled in Starshipit?**
Go to **Settings > Integrations > Shopify > Advanced > Writeback** and confirm that **Disable Shopify customer notification** is not enabled. If it is, Shopify will not send notification emails on writeback.
**Check 2: Is writeback actually firing?**
If writeback is disabled, Shopify never receives the update and cannot send a notification. See the "Writeback is not firing at all" section above.
**Check 3: Are Shopify email notifications turned on?**
In your Shopify admin, go to **Settings > Notifications** and confirm the relevant shipping notification templates are enabled.
---
## Fulfillment event writeback (transit status) is not working
This applies when transit status updates (Out for delivery, Delivered) are not appearing in Shopify.
Work through this checklist:
1. **Enable fulfillment event writeback** — Go to **Settings > Integrations > Shopify > Advanced** and confirm **Enable fulfillment event writeback** is on.
2. **Customer notification must be enabled** — If **Disable Shopify customer notification** is on, fulfillment event writeback will not function. Disable the "disable" setting.
3. **Writeback must be enabled** — Confirm **Disable Writeback** is not checked.
4. **Enable Shopify notification templates** — In your Shopify admin, go to **Settings > Notifications > Shipping** and enable the transit status notifications you want Shopify to send.
5. **Carrier must provide tracking events** — Transit status writeback depends on the carrier returning tracking events to Starshipit. Confirm the carrier and service you are using returns tracking events.
---
## Webhook subscription fails or webhooks are not working
**To resolve:**
1. Go to **Settings > Integrations > Shopify Settings** and save your settings (even without changes).
2. Scroll to the bottom of the page and click **Subscribe to webhook**.
3. If the subscription still fails, reauthorise the Shopify integration and try again.
:::note
Classic and Enhanced use different webhook identifiers. If you have recently switched between versions, the existing webhook subscription may be stale. Save, reauthorise, and resubscribe.
:::
---
# Connect Shopline to Starshipit
URL: https://support.starshipit.com/articles/12019455466895-connect-shopline-to-starshipit
Canonical: https://support.starshipit.com/articles/12019455466895-connect-shopline-to-starshipit
Markdown: https://support.starshipit.com/articles/12019455466895-connect-shopline-to-starshipit.md
Updated: 2026-05-06
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Learn how to integrate with shopline.
Integrate Starshipit with Shopline to seamlessly import your orders and automate fulfillment. Orders from Shopline will automatically sync with Starshipit, tracking details will be sent back once orders are fulfilled, and order status updates will be handled automatically.
## What you need to get started
* A **Shopline account** with API access.
* Your **Shopline subdomain** (e.g., **yourcompany**.myshopline.com).
* Your **Shopline API Key** with the necessary permissions.
## Setup Required on Shopline
1. In your Shopline account, go to **Settings**
2. From the left hand sidebar, choose **Apps**
3. From the top left, press **Develop Apps**
4. From the top left, press **Create an App**
5. Give this app a convienient name, like **Starshipit**
6. **Install the app to your shopline store**
7. Assign the required permissions to this app. For the Starshipit Integration, these are:
***write_orders***
***read_orders***
8. Take note of the **access token to request data from Admin API**. This is what we refer to as the **API Key**.
## How to set up Shopline
1. In your Starshipit account, go to **Settings >** **Integrations**.
2. Click **Add a new integration** and select **Shopline** from the list.
3. Enter your **Shopline API Key and subdomain**.
4. Click **Save**.
### Set the order status to import
1. In **Settings** > **Integrations**, select **Shopline settings**
2. Choose the **order status to import** from the dropdown menu.
3. Click **Save**.
Once saved, click **Fetch latest orders** to confirm your integration is working correctly.
## Additional Features
**Order Status Sync**: Orders will **automatically update** in Shopline when they are shipped from Starshipit.
Tracking information will be sent back to Shopline, updating the order status.
## Configure Shopline settings
| Setting | What it does |
| --- | --- |
| **Enable Shopline** | Turns the integration on or off. |
| **API key** | Authenticates Starshipit with Shopline. Keep it private. |
| **Subdomain** | Identifies your Shopline store subdomain. |
| **Status** | Sets the Shopline order status Starshipit imports. The available statuses are supplied by Shopline. |
Save the settings and use **Test connection** to verify the API key and subdomain.
---
# Connect Square to Starshipit
URL: https://support.starshipit.com/articles/12219571430543-connect-square-to-starshipit
Canonical: https://support.starshipit.com/articles/12219571430543-connect-square-to-starshipit
Markdown: https://support.starshipit.com/articles/12219571430543-connect-square-to-starshipit.md
Updated: 2026-05-06
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Learn how to integrate with squareup.
Integrate Starshipit with SquareUp to seamlessly import your orders and automate fulfillment. Orders from SquareUp will automatically sync with Starshipit, tracking details will be sent back once orders are fulfilled, and order status updates will be handled automatically.
## What you need to get started
* A SquareUp Account.
## How to set up SquareUp
1. In your Starshipit account, go to **Settings >** **Integrations**.
2. Click **Add a new integration** and select **SquareUp** from the list.
3. Click Authorize
4. In the pop-up window, sign in with your **SquareUp** account.
5. Once you have signed in, wait for the page to reload
6. Specify the **location** in **SquareUp** to import orders from.
7. Click **Save**.
### Set the order status to import
1. In **Settings** > **Integrations**, select **SquareUp settings**
2. Choose the **order status to import** from the dropdown menu.
3. Click **Save**.
Once saved, click **Fetch latest orders** to confirm your integration is working correctly.
## Additional features
**Order Status Sync**: Orders will **automatically update** in SquareUp when they are shipped from Starshipit.
Tracking information will be sent back to SquareUp, updating the order status.
## Configure Square settings
| Setting | What it does |
| --- | --- |
| **Enable SquareUp** | Turns the integration on or off. |
| **Access token** | Authenticates Starshipit with Square. Keep it private. |
| **Refresh token** | Lets Starshipit refresh the Square authorisation when required. |
| **Token expires at** | Shows when the current access token expires. This is managed by the connection and normally should not be changed manually. |
| **Import status options** | Selects the Square order statuses to import. |
| **Location IDs** | Limits imports to the selected Square locations. |
Authorise the connection, save the settings, and test a location-specific order before enabling automatic imports.
---
# Connect Squarespace to Starshipit
URL: https://support.starshipit.com/articles/360004520196-connect-squarespace-to-starshipit
Canonical: https://support.starshipit.com/articles/360004520196-connect-squarespace-to-starshipit
Markdown: https://support.starshipit.com/articles/360004520196-connect-squarespace-to-starshipit.md
Updated: 2026-07-21
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Integrate Starshipit with Squarespace to import orders and automatically write back tracking information when you print labels.
Integrate Starshipit with Squarespace to import orders and automatically write back tracking information when you print labels or manifest orders. You can integrate as many Squarespace stores into your Starshipit account as you like.
## What you need to get started
* Your Squarespace account will need to be on a Commerce Advanced plan.
* Your Squarespace Store URL
* Your Squarespace API Key
If you don't have your API key already, you can find this by following [these steps in Squarespace](https://support.squarespace.com/hc/en-us/articles/236297987?_ga=2.37255781.477448643.1622056765-156394582.1619058105). You will need the following permissions for the integration to be able to import orders and update tracking information.
| | |
| --- | --- |
| Inventory API | **Read and Write**: Manage inventory stock levels |
| Orders API | **Read and Write**: View customer information (name, email, address, and more); manage order and fulfillment information |
| Transactions API | **Read Only**: View transactional order, donation data, and customer information (email) |
| Products API | **Read Only**: View product information, including information for any images and variants; view Store Page information |
## How to set up Squarespace
1. In your Starshipit account, go to **Settings**>**Integrations**.
2. Click **Add a new integration** > select **Squarespace** from the list.
3. Tick **Enable Squarespace**.
4. Enter your **Store Url**.
5. Enter your **Store Name**.
6. Enter your **Squarespace API key**.
7. Select your **Order status to import**.
8. Click **Save**.
Once saved, click **Test to ensure it works** to confirm your integration is set up correctly.
## Additional Features
### Import only orders with physical products
If your Squarespace store also sells services, events, or workshops, you can prevent service-only orders from being imported into Starshipit.
1. Go to **Settings > Integrations > Squarespace**.
2. Open the advanced settings.
3. Turn on **Only import orders with physical products**.
4. Click **Save**.
Starshipit will skip orders that contain no physical products. Orders that contain both physical products and services will still import with all their items and values.
**Delivery Instructions**: Starshipit can automatically import delivery instructions from your store. To do this, you will need to create a custom checkout form and ensure it is called Delivery Instructions or Delivery Instruction. For more information, check out Square Space's instructions [here.](https://support.squarespace.com/hc/en-us/articles/360002095328-Adding-a-delivery-option#:~:text=Save.-,Add%20a%20custom%20checkout%20form%20for%20delivery%20information,-After%20you%20add)
**Unit of Measure**: Starshipit can import either Pounds, Kilo's or Grams from SquareSpace. To specify which unit you are using, go to **Settings** > **Options** > **Import Weight Unit**.
## Configure Squarespace settings
| Setting | What it does |
| --- | --- |
| **Enable Squarespace** | Turns the integration on or off. |
| **Store URL** | The URL of your Squarespace store. |
| **Store name** | The name used to identify the store in Starshipit. |
| **Squarespace API key** | Authenticates Starshipit with Squarespace. Keep it private. |
| **User ID** | The Squarespace user identifier used by the connection. |
| **Scopes** | The Squarespace API permissions requested by the connection. |
| **Order status to import** | The Squarespace order status Starshipit imports. |
| **Only import orders with physical products** | Skips orders that contain no physical products. |
Save the settings and test the connection before importing orders.
---
# Connect The Iconic to Starshipit
URL: https://support.starshipit.com/articles/8280028788751-connect-the-iconic-to-starshipit
Canonical: https://support.starshipit.com/articles/8280028788751-connect-the-iconic-to-starshipit
Markdown: https://support.starshipit.com/articles/8280028788751-connect-the-iconic-to-starshipit.md
Updated: 2026-05-06
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Connect The Iconic to Starshipit and manage marketplace orders through your existing system.
## How The Iconic works with Starshipit (Order process overview)
1. The customer places an order on The Iconic.
2. The order is automatically sent to your eCommerce platform or inventory management system (For example, Shopify, Cin7 etc). Some platforms will automatically import your orders from The Iconic. Others may require a third-party-party connector (See below for more information).
3. Starshipit automatically imports the order from this platform and:
1. Assigns a courier (based on rules you set).
2. Sends out tracking notifications to customers.
4. Starshipit writes back tracking information and order updates to your platform.
5. Your eCommerce platform or inventory management system will write back order updates to The Iconic, using the third-party connector if required.
## How to get started
## Step 1: Integrate The Iconic with your eCommerce platform or inventory management system
The first step is to integrate The Iconic with your platform of choice.
How you set up The Iconic depends on which platform you use. We have outlined the instructions for some common platforms below.
### Using The Iconic with Cin7 Omni
If you’re using Cin7 Omni, you can simply install The Iconic Marketplace app directly from the Cin7 Marketplaces tab in Cin7.
Here are the step-by-step instructions from Cin 7’s website:
* [Set up The Iconic (marketplace) (cin7.com)](https://help.omni.cin7.com/hc/en-us/articles/9128597138063-Set-up-The-Iconic-marketplace)
### Using The Iconic with other platforms (Shopify, BigCommerce, WooCommerce, Magento)
If you’re using another platform, like Shopify or BigCommerce, for example, you’ll need to use a third-party connector to link with The Iconic. Thankfully, there are a few great options that are easy to set up.
In most cases, these connectors match the products in your platform and The Iconic Marketplace. Orders from The Iconic are passed to your platform for processing. Once fulfilled, the connectors send the status back to your marketplace.
We have linked some of the most popular connectors below, along with integration guides on how to get set up (where available):
* [Comestri](https://www.comestri.com/)
+ [Connect Omnivore to The Iconic : Omnivore Support](https://support.omnivore.com.au/support/solutions/articles/17000125540-connect-omnivore-to-the-iconic)
* [IDA Connect](https://www.idaconnect.com/)
+ [IDA-Connect-Guide-2.10.pdf (idaconnect.com)](https://idaconnect.com/wp-content/uploads/IDA-Connect-Guide-2.10.pdf)
* [Crossfire](https://crossfireintegration.com/integrations/trading-partners/the-iconic/)
+ [The Iconic EDI (crossfireintegration.com)](https://crossfireintegration.com/integrations/trading-partners/the-iconic/)
* [Channel engine](https://www.channelengine.com/)
+ [The Iconic (channelengine.com)](https://www.channelengine.com/en/marketplaces/the-iconic)
* [Intelligent Reach](https://www.intelligentreach.com/)
* [Indigo8](https://www.indigo8-solutions.com/)
* [Omnivore](https://www.omnivore.com.au/)
## Step 2: Manage orders from The Iconic in Starshipit
Once you’ve set up your eCommerce platform or inventory management system, Starshipit will automatically import orders from The Iconic as they’re imported into your eCommerce platform or inventory management system.
At this point, you can manage these orders in the same way as you’d manage any other orders. You can:
* **Assign carriers:** Whether manually or based on [shipping automation rules](/articles/notifications-branded-tracking-rules-child-accounts/business-rules/rules-overview) you setup, assign orders from The Iconic to your carriers.
* **Create and send out delivery updates:** Customise and send out [branded tracking notifications](/articles/notifications-branded-tracking-rules-child-accounts/notifications/about-notifications-and-branded-tracking) (linked to branded tracking pages) to keep your customers informed about the status of their orders from The Iconic.
Starshipit then writes back order updates and other relevant information to your eCommerce platform or inventory management system.
---
# Connect Trade Me to Starshipit
URL: https://support.starshipit.com/articles/203826609-connect-trade-me-to-starshipit
Canonical: https://support.starshipit.com/articles/203826609-connect-trade-me-to-starshipit
Markdown: https://support.starshipit.com/articles/203826609-connect-trade-me-to-starshipit.md
Updated: 2026-05-06
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Integrate your Trade Me platform with Starshipit to import orders and write back tracking information when you print labels.
Integrate your Trade Me platform with Starshipit to import orders and write back tracking information when you print labels.
:::note
Trade Me doesn't let Starshipit import the item details, however, the item details are not required to ship domestically.
:::
## How to integrate your Trade Me account to Starshipit
1. In Starshipit, navigate to **Settings** > **Integrations**.
2. Click **Add a new integration** and select Trade Me from the list of integrations.
3. Click **Get Authorization Link** and you will be redirected to the Trade Me website.
4. Enter your Trade Me Account username and password.
5. Copy the generated code and paste it into the **Trade Me verifier code** field.
6. Click **Save**.
#### Screenshot_2019-07-05_13.41.13.png
:::warning
The status of the orders must be set to "Payment Received" before importing
:::
## Troubleshooting
**Q. My Test Connection failed**
A. Follow the integration steps again. If it fails again, please contact our support team [here](https://help.starshipit.com).
**Q. My Afterpay orders are not importing**
A. We do not currently support importing of orders that have a status of shipped (30), all Afterpay orders automatically have a status of 30.
## Configure Trade Me settings
| Setting | What it does |
| --- | --- |
| **Enable Trade Me** | Turns the integration on or off. |
| **Key** | The Trade Me application key. |
| **Secret** | The Trade Me application secret. Keep it private. |
| **Import reference number** | Imports the Trade Me reference number into the Starshipit order when enabled. |
Use **Get Authorization Link** to authorise the connection, then save and test it.
---
# Connect Tradevine to Starshipit
URL: https://support.starshipit.com/articles/204503235-connect-tradevine-to-starshipit
Canonical: https://support.starshipit.com/articles/204503235-connect-tradevine-to-starshipit
Markdown: https://support.starshipit.com/articles/204503235-connect-tradevine-to-starshipit.md
Updated: 2026-05-06
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Integrate your Tradevine platform with Starshipit to import orders and write back tracking information when you print labels.
Integrate your Tradevine platform with Starshipit to import orders and write back tracking information when you print labels.
## Integrate with Tradevine
1. In Starshipit, navigate to **Settings** > **Integration** > **Add a new integration**.
2. Select **Tradevine** from the list of integration.
3. Tick **Enable Tradevine**.
4. Login to your Tradevine account and navigate to **Settings** > **API Applications**.
5. Select **All Applications** and find the **Starshipit** app.
6. Press the **Authorise** button and you will be taken to the page which then lists your Access token and Token secret.
7. Copy and paste your Access token and Token secret to the Tradevine integration page in Starshipit.
8. Click **Test to ensure it works** to ensure your credentials are valid.
9. Click **Save.**
10. Once you import your orders from the Shipping Tab, you will be prompted to log in to your Tradevine account.
## Troubleshooting
#### **An error message is coming up" The remote server returned an error:(403) forbidden." What do I do?**
Check your API settings in Starshipit and compare it to what is in Tradevine. If it says 'Not authorised' then it is most likely due to the Tradevine account credentials.
Account credentials expire and may need to be renewed. Contact Tradevine to see if this is the case.
## Configure Tradevine settings
| Setting | What it does |
| --- | --- |
| **Enable Tradevine** | Turns the integration on or off. |
| **Access token** | Authenticates Starshipit with Tradevine. |
| **Token secret** | The secret paired with the Tradevine access token. Keep it private. |
| **Email to buyer on writeback** | Sends the buyer an email when shipment details are written back. |
| **Tradevine attributes** | Controls the integration attribute used for order-number handling, including using the packslip number instead of the sales order number where applicable. |
Save the settings and use **Test connection** to verify the credentials.
---
# Connect Unleashed to Starshipit
URL: https://support.starshipit.com/articles/204503225-connect-unleashed-to-starshipit
Canonical: https://support.starshipit.com/articles/204503225-connect-unleashed-to-starshipit
Markdown: https://support.starshipit.com/articles/204503225-connect-unleashed-to-starshipit.md
Updated: 2026-08-26
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Integrate your Unleashed platform with Starshipit to import orders and write back tracking information when you print labels.
Integrate your Unleashed platform with Starshipit to import orders and write back tracking information when you print labels. Unleashed require an extra step to activate the write-back functionality. Please follow the instructions for [Unleashed updating orders](/articles/troubleshooting/integrations/unleashed-updating-orders). There are two versions of Unleashed, Classic and Enhanced. We recommend using Enhanced as this has support for importing sales shipments rather than sales orders.
## What you need to get started:
Before getting started with Unleashed you will need a few things.
* Your Unleashed API Id. This can be found [here](https://ap.unleashedsoftware.com/v2/Integration/Api).
* Your Unleashed API Key. This can be found [here](https://ap.unleashedsoftware.com/v2/Integration/Api).
## How to set up Unleashed:
To enable Unleashed on your Starshipit account:
1. Go to **Settings** > **Integrations** > **Add a new integration** > **Unleashed**.
2. Select one of the following integration versions using the toggle button:
* **Classic**
This will import Sales Orders. Please note that Classic is now deprecated.
* **Enhanced**
This allows you to import different shipments from Unleashed. Starshipit checks the status of both the Sales Order and Sales Shipment during import.
3. Tick **Enable Unleashed**.
4. Enter your Unleashed Id and User Key.
5. Click **Save** to save your changes.
6. Test the connection and you're good to go!
## Additional Configuration
Unleashed offers more customization over how and when you import your orders. To configure them, navigate to **Settings** > **Integrations** > **Unleashed Settings**.
**Status to import**: Use this option to select what status orders should be in to import into Starshipit.
**Never Diminishing Products**: If you use never-diminishing products with Unleashed, we recommend enabling this setting to mark the order as "Complete".
**Import comments**: If you have comments on your order and would like to import them to Starshipit, select this option. The comments will be imported into the delivery instructions field.
**Set freight/shipping cost**: Specify which item represents the freight charge so Starshipit removes its cost from the declared value.
1. In the **Set freight/shipping cost** section, enter the shipping charge item name, such as `Shipping;Freight`.
2. Click **Save**.
3. Import a new order and confirm the freight item is excluded as a line item and represented as the freight cost.
**Import Product Details**: Turn this on to import product dimensions and the main product image URL from Unleashed. Starshipit applies available width, height and depth to the imported order item, and uses the image URL when Unleashed provides one. This works for both Classic and Enhanced Unleashed imports.
If an item has missing or zero dimensions, Starshipit does not overwrite valid dimensions already on the order. A missing image URL does not stop the order import.
## Import bin locations
When Unleashed provides a bin location for an imported order item, Starshipit makes it available in Packing Validation. Import a test order and check the item's bin location before relying on it in a pick-and-pack workflow.
## Show pack contents on packing slips
If you sell Unleashed assembly or pack products, enable **Show assembly contents on packing slips** in the Unleashed advanced settings. Starshipit imports the pack components beneath the parent item so supported packing slips can show the contents without changing the shipment quantity or write-back.
## Configure Unleashed settings
| Setting | What it does |
| --- | --- |
| **Enable Unleashed** | Turns the integration on or off. |
| **Integration Version** | Selects **Classic** or **Enhanced**. Enhanced supports sales shipments and is recommended. |
| **API ID** and **API Key** | Authenticate Starshipit with Unleashed. Keep the key private. |
| **Status to import** | Selects one or more Unleashed statuses for import. Separate multiple statuses with semicolons. |
| **Set freight/shipping cost** | Identifies freight item names so Starshipit excludes their value from the declared value and records the charge as shipping cost. |
| **Import comments** | Copies Unleashed comments into Starshipit delivery instructions. |
| **Writeback to first existing shipment** | Writes tracking to the first existing Unleashed shipment when enabled. |
| **Use writeback queue** | Queues tracking writeback so it can be retried if Unleashed is temporarily unavailable. |
| **Never Diminishing Products** | Completes never-diminishing products on writeback when your Unleashed workflow requires it. |
| **Do not import invoice customer name** | Prevents the invoice customer name from being imported. |
| **Import product details** | Imports product information with order lines. |
| **Product dimensions unit** | Selects whether imported dimensions are in metres, centimetres, millimetres, or inches. |
| **Import pack contents** | Imports the contents of Unleashed packs or bundles. |
Save the settings and test a connection and order import before turning on automatic fulfilment.
---
# Unleashed: Updating orders
URL: https://support.starshipit.com/articles/202749509-unleashed-updating-orders
Canonical: https://support.starshipit.com/articles/202749509-unleashed-updating-orders
Markdown: https://support.starshipit.com/articles/202749509-unleashed-updating-orders.md
Updated: 2026-05-07
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Learn how to update the status of your orders in Unleashed after shipping with Starshipit.
This article outlines how to update the status of your orders in Unleashed after shipping with Starshipit.
## Set up
To update the shipping status of your orders in Unleashed:
1. In Starshipit, navigate to **Settings** > **Integrations** > **Unleashed Settings**.
2. Check which **Integration Version** has been selected.
- **Classic**: Imports orders. Classic is not recommended as the API is no longer supported.
- **Enhanced**: Imports [shipments](https://support.unleashedsoftware.com/hc/en-us/articles/360038386572-How-to-create-a-Shipment-without-completing-a-Sales-Order). Note that if the shipment is already dispatched, it cannot be imported.
3. Navigate to **Settings** > **Couriers**.
4. Add each of the carriers you have set up in Starshipit into Unleashed settings.
5. In Unleashed, navigate to **Settings** > **System** > **Shipping Companies** and add the names of all the carriers.
## Troubleshooting
### What status will the order be marked as after the update?
Orders will be set to **Complete**.
### My orders aren't importing
If your orders aren't coming through, try clearing your browser cache. Failing that, open the order in Starshipit and save the order without making any changes. If your orders still aren't importing, please contact our [support team](https://help.starshipit.com).
### Can you process the orders as partial shipments?
Partial shipments are currently not supported by Unleashed.
### Can you process the orders as merged?
Merged order writeback is currently not supported.
---
# Connect a website builder to Starshipit via FTP
URL: https://support.starshipit.com/articles/115002674626-connect-a-website-builder-to-starshipit-via-ftp
Canonical: https://support.starshipit.com/articles/115002674626-connect-a-website-builder-to-starshipit-via-ftp
Markdown: https://support.starshipit.com/articles/115002674626-connect-a-website-builder-to-starshipit-via-ftp.md
Updated: 2026-05-06
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Integrate your Website Builder platform with Starshipit using your FTP connection information.
Integrate your Website Builder platform with Starshipit using your FTP connection details.
## Setting up Website Builder
### 1. Get your connection information
1. Log into your Website Builder back end.
2. Go to the **MANAGE FILES** area in the left menu.
3. Copy the FTP password for the next step.
### 2. Enter your connection information in Starshipit
1. Navigate to **Settings** > **Integration**.
2. Click **Add a new integration** and select **WebsiteBuilder** from the list of integrations.
3. Tick **Enable Website Builder**.
4. Enter your WebsiteBuilder details.
5. Click Save.
## Configure Website Builder settings
| Setting | What it does |
| --- | --- |
| **Enable Website Builder** | Turns the integration on or off. |
| **URL** | The Website Builder site URL. Use the URL format provided by your Website Builder account. |
| **API Password** | Authenticates Starshipit with Website Builder. Keep it private. |
Save the settings and use **Test connection** to verify the URL and API password.
---
# Connect Wix to Starshipit
URL: https://support.starshipit.com/articles/4403532746255-connect-wix-to-starshipit
Canonical: https://support.starshipit.com/articles/4403532746255-connect-wix-to-starshipit
Markdown: https://support.starshipit.com/articles/4403532746255-connect-wix-to-starshipit.md
Updated: 2026-05-06
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Learn how to integrate with Wix.
Integrate Starshipit with Wix to import your orders directly. Once orders are fulfilled, Starshipit will send the tracking data back to Wix and update the order status automatically.
## How it works
#### 1. Set up Wix
1. Navigate to **Settings >** **Integrations.**
2. Select **Add a new integration.**
3. Select **Wix** from the list of eCommerce Platforms.
4. Click the **Authorize** button.
5. This will redirect you to Wix to log into your Wix account and give Starshipit permission to access your order data.
6. On the Wix page, click **Agree & Add**.
You will then be redirected back to Starshipit. Your Store URL and Store Name will be automatically populated. Wix will automatically be enabled.
#### 2. Set the order status to import
1. From the **Integrations** page, select **Settings** next to Wix.
2. Set the fullfilment status of orders to import from the dropdown menu.
The default is 'NOT_FULFILLED'.
3. If you want to import more than one status at the same time, click into the dropdown menu and separate/separated status boxes using '**;**'. For example, NOT_FULLFILLED;CANCELLED
4. Click **Save.**
#### 3. Set orders to import automatically
You can set Starshipit to automatically import new orders from Wix every 20 minutes.
1. From the **Integrations** page, click the checkbox next to **Automatically import orders from all integrations (typically every 20 minutes)**.
2. When you've sent out your orders Starshipit will write back tracking details to Wix and mark your orders as fulfilled.
## Configure Wix settings
| Setting | What it does |
| --- | --- |
| **Enable Wix** | Turns the integration on or off. |
| **Store URL** | The URL of your Wix store. |
| **Store name** | Identifies the Wix store in Starshipit. |
| **Order status to import** | Sets the Wix fulfilment or order status Starshipit imports. |
| **Map address line 2 to suburb** | Places Wix address line 2 in Starshipit’s Suburb field. |
| **Instance ID** | Identifies the Wix instance when one is supplied by Wix. |
| **Refresh token** | Allows Starshipit to refresh the Wix authorisation. Keep it private. |
| **Access token** | The Wix access token used by the connection. Keep it private. |
Save the settings and use **Test connection** to verify the store credentials.
---
# Connect WooCommerce to Starshipit
URL: https://support.starshipit.com/articles/203826249-connect-woocommerce-to-starshipit
Canonical: https://support.starshipit.com/articles/203826249-connect-woocommerce-to-starshipit
Markdown: https://support.starshipit.com/articles/203826249-connect-woocommerce-to-starshipit.md
Updated: 2026-07-08
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Learn how to integrate with WooCommerce.
Integrate Starshipit with WooCommerce to import orders and automatically write back tracking information. You can also disable email notifications in WooCommerce if using Starshipit's notification system.
## 1. Generate your API key in WooCommerce
In order to import orders from your store, Starshipit needs some information which can be found in your WooCommerce dashboard.
1. From your WooCommerce dashboard, select **WooCommerce** > **Settings**.
2. Click the **Advanced** tab.
3. Select **REST API** near the top of the screen, then click **Add Key**.
4. In the **Description** field, enter **Starshipit Integration**.
5. Select a user.
6. In the **Permissions** menu, select **Read/Write**.
7. Click **Generate API key**.
8. Copy the **Consumer Key** and **Consumer Secret**. You will have to paste this in the Starshipit integration settings.
:::note
If you want to use the Legacy Version 1 or Legacy Version 2 integrations, you will need to enable the Legacy API on WooCommerce.Using the legacy integrations is not recommended.
:::
1. From your WooCommerce dashboard, select **WooCommerce** > **Settings**.
2. Click the **Advanced** tab.
3. Click **Legacy API** near the top of the screen.
4. Tick **Enable the legacy REST API**.
5. Click **Save changes.**
## 2. Add WooCommerce as an integration in Starshipit
1. In your Starshipit account, go to **Settings** > **Integrations**.
2. Click **Add a new integration**, and select **WooCommerce** from the list.
3. Select the **Enable WooCommerce** checkbox.
4. Under **WooCommerce API version**, select **Latest Version 3**.
5. Enter your store domain name starting with http or https i.e. https://yourstore.com.
If you do not know your store domain name, check your **WooCommerce dashboard** > **Settings** > **General** > **Site Address (URL)**.
6. Paste your **Consumer Key** and **Consumer Secret** copied from WooCommerce.
7. Enter or select your **Status to import**.
8. Fill out any other details as required.
9. Select a **Writeback Method** using the dropdown menu. Starshipit will write-back the Tracking Number, Carrier Name and Tracking URL in the instruction field.
10. (Optional) Select **Enable customer notifications when creating order note on writeback**. Customer notifications will automatically be sent when Starshipit writes back the tracking details in a note.
11. Click **Save**.
## 3. Set your writeback method
Writeback is when Starshipit sends back tracking information to WooCommerce. Learn more information about writeback [here.](/articles/orders-manifests-reports/faqs/does-starshipit-automatically-update-my-integrated-ecommerce-platform)
With the **Latest Version 3**WooCommerce integration you can configure two different writeback methods.
To configure your writeback method follow the below steps:
1. In your Starshipit account, go to **Settings >** **Integrations**.
2. Click **Settings** next to **WooCommerce**.
3. Scroll down until you see the option **Writeback Method**.
4. From the dropdown select either of the two options:
* Create an Order Note
* Update using Shipment Tracking Plugin
**Create an Order Note**
When an order in Starshipit is printed or manifested, Starshipit will set the order status to complete in WooCommerce, and add an order note to the order.
You can also set the order note created to also trigger a notification to the customer. To do this enable the **Enable customer notifications when creating order note** tickbox option in WooCommerce settings when you have the **Create an Order Note** writeback method selected.
**Update using Shipment Tracking Plugin**
This method allows you to use the WooCommerce Shipment Tracking Plugin. The plugin adds tracking fields into WooCommerce as there are no native fields on WooCommerce.
You can purchase the plugin and find instructions for installing it [here](https://woocommerce.com/products/shipment-tracking/).
By using the plugin to add these fields, you can setup other integrations with WooCommerce (like Amazon, eBay and The Iconic) to read from these fields for the purpose of writing back to those platforms when an order is shipped.
**Importing item images**
Starshipit now supports importing images from WooCommerce. Starshipit will automatically import images stored against your products. You can then display these images on packing slips and packing summaries.
## 4. Import WooCommerce orders
1. From the Starshipit Main Menu, select **Orders**.
2. Click **Import** at the top right of the screen, and select **Import Orders** from the dropdown menu.
3. Select **WooCommerce**, and enter the number of days you want the importer to check for orders.
4. Click **Import**. Starshipit imports the orders based on your **Status to import** selection for WooCommerce e.g. **Processing**.
5. Click **Close**once importing is complete.
## (Optional) Disable email notifications in WooCommerce
Should you choose to use [Starshipit branded notifications,](/articles/notifications-branded-tracking-rules-child-accounts/notifications/about-notifications-and-branded-tracking) you can disable email notifications from being triggered to be sent by your WooCommerce store.
1. From your WooCommerce dashboard, select **WooCommerce** > **Settings**.
2. Select the **Emails**tab.
3. Select the order email template you would like to disable. e.g. **Completed order**.
4. Clear the **Enable this email notification** checkbox.
5. Click **Save changes**.
## (Optional) Import additional product attributes
You can also import the size and colour of your products from your WooCommerce store by using [WooCommerce Product Attributes.](https://woocommerce.com/document/managing-product-taxonomies/#section-7)
* Starshipit relies on the attributes being labelled "Size" and "Color" specifically for these to be picked up by the importer.
**Partial Shipments are not supported with this integration.**
## Configure WooCommerce settings
| Setting | What it does |
| --- | --- |
| **Enable WooCommerce** | Turns the integration on or off. |
| **Store URL** | Your WooCommerce store URL. |
| **Consumer key** and **Consumer secret** | WooCommerce API credentials used by Starshipit. Keep them private. |
| **Status** | The WooCommerce order status Starshipit imports. |
| **Version** | Selects the WooCommerce API version used by the connection. |
| **Use Query String** | Sends API parameters in the query string when your server requires it. |
| **Use HTTP POST method** | Uses HTTP POST for requests when your server or security configuration requires it. |
| **Create order note** | Adds Starshipit shipment information as a WooCommerce order note. |
| **Send customer notification** | Sends a WooCommerce customer notification when Starshipit writes back. |
| **Map address line 2 as building** | Maps the second address line to Starshipit’s Building field. |
| **Do not import notes** | Prevents WooCommerce order notes from being imported. |
| **Custom request header** | Adds a custom HTTP header to WooCommerce requests when your store requires one. |
| **Remove date from query** | Removes the date parameter from import requests. Use this only when troubleshooting a store-specific query issue. |
| **Support partial updates** | Allows the integration to send partial updates when supported by your WooCommerce setup. |
Depending on your WooCommerce connection, you can also choose the update unit, update method, and writeback method. Complete these choices during setup, then save and test the connection. You can update them later from **Settings > Integrations**.
---
# WooCommerce - Importing HS Code & Country of Manufacture
URL: https://support.starshipit.com/articles/360002952915-woocommerce-importing-hs-code-country-of-manufacture
Canonical: https://support.starshipit.com/articles/360002952915-woocommerce-importing-hs-code-country-of-manufacture
Markdown: https://support.starshipit.com/articles/360002952915-woocommerce-importing-hs-code-country-of-manufacture.md
Updated: 2026-05-06
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Import HS Code and Country of Manufacture from WooCommerce by creating custom product attributes.
Import HS Code and Country of Manufacture from WooCommerce by creating custom product attributes in your WooCommerce backend.
## 1. Create new Product Attribute for HS Code
To import HS Code and Country of Manufacture from WooCommerce, you first need to create product attributes from your WooCommerce backend.
1. Go to **Products**, then select **Attributes**.
2. Fill in the Name field with **hs_code**, then click **Add attribute**.
3. You will be redirected back to the Attributes page and **hs_code** should be available for editing. Click on **hs_code** from the grid.
4. Fill in the Name field with your custom HS Code, then select **Add new hs_code**.
## 2. Assign HS Code Product Attribute to a Product
1. Go to **Products,**then select **All Products**.
2. Select a product that you would like to add the HS Code for.
3. Under **Product data** section, select **Attributes.**
4. Select **Custom product attribute**dropdown list and set it to **hs_code** then click **Add**.
5. Click on **Select terms**and assign the **hs_code** value.
6. Untick **Visible on the product page** then click on **Save attributes.**
## 3. Create new Product Attribute for Country of Manufacture/Country of Origin
1. Go to **Products**, then select **Attributes**.
2. Fill in the Name field with **country_of_manufacture** or **country_of_origin**, then click **Add attribute**.
3. You will be redirected back to the Attributes page and **country_of_manufacture** or **country_of_origin** should be available for editing. Click on **country_of_manufacture** or **country_of_origin** from the grid.
4. Fill in the Name field with your custom Country of Manufacture/Country of Origin, then select **Add new country_of_manufacture** or **Add new country_of_origin**.
## 4. Assign Country of Manufacture Product Attribute to a Product
1. Go to **Products,**then select **All Products**.
2. Select a product that you would like to add the Country of Manufacture for.
3. Under **Product data** section, select **Attributes.**
4. Select **Custom product attribute**dropdown list and set it to **country_of_manufacture** or **country_of_origin** then click **Add**.
5. Click on **Select terms**and assign the **country_of_manufacture** or the **country_of_origin** value.
6. Untick **Visible on the product page** then click on **Save attributes.**
---
# WooCommerce: Set up delivery options
URL: https://support.starshipit.com/articles/360000914476-woocommerce-set-up-delivery-options
Canonical: https://support.starshipit.com/articles/360000914476-woocommerce-set-up-delivery-options
Markdown: https://support.starshipit.com/articles/360000914476-woocommerce-set-up-delivery-options.md
Updated: 2026-05-06
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Step-by-step guide to setting up WooCommerce: delivery options.
This article outlines how to import Authority to Leave or Signature Required information for WooCommerce orders.
## Import delivery options
For Starshipit to import Authority to Leave or Signature required information, you need to create two Meta fields:
* **authority_to_leave**
values can be: 0, 1, true, false, yes, no
* **signature_required**
values can be: 0, 1, true, false, yes, no
These two fields will be imported automatically.
Here is an example on how to display and create these fields. In Function.php add the following code:
```
/** Add the field signature_required to the checkout page */
add_action('woocommerce_after_order_notes', 'is_signature_required');
function is_signature_required($checkout){
echo '
';}
add_action('woocommerce_checkout_update_order_meta', 'is_signature_required_field_update_order_meta');
function is_signature_required_field_update_order_meta($order_id) {
if (!empty( $_POST['signature_required'])){
update_post_meta($order_id, 'signature_required', sanitize_text_field( $_POST['signature_required']));
}
}
```
```
/** Add the field authority_to_leave to the checkout page */
add_action('woocommerce_after_order_notes', 'is_atl_required');
function is_atl_required($checkout){
echo '
';}
add_action('woocommerce_checkout_update_order_meta', 'is_atl_required_field_update_order_meta');
function is_atl_required_field_update_order_meta($order_id) {
if (!empty($_POST['authority_to_leave'])){
update_post_meta($order_id, 'authority_to_leave', sanitize_text_field( $_POST['authority_to_leave']));
}
}
```
---
# WooCommerce: Troubleshooting
URL: https://support.starshipit.com/articles/360000906655-woocommerce-troubleshooting
Canonical: https://support.starshipit.com/articles/360000906655-woocommerce-troubleshooting
Markdown: https://support.starshipit.com/articles/360000906655-woocommerce-troubleshooting.md
Updated: 2026-05-07
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Learn how to troubleshoot and resolve common issues with the WooCommerce integration.
This article outlines common errors with the Starshipit/WooCommerce integration and how to resolve them. For setup instructions, see [how to integrate with WooCommerce](/articles/integrations/ecommerce-platforms/how-to-integrate-with-woocommerce).
## Error: Unsuccessful - The remote server returned an error: (400) Bad Request.
If you test the connection and get this error, you may need to enable permalinks. To do this:
1. In your WooCommerce account, select **Settings**, then select **Permalinks**.
2. Under **Common Settings**, select **Post name**.
3. Click **Save changes**.
4. In your [Starshipit](https://app2.starshipit.com/) account, go to **Settings**, then select **Integrations**.
5. Select **Settings** next to WooCommerce.
6. Scroll down and click **Test to ensure it works.**
You should get a successful result. If you continue to receive an error, please contact our [support team](https://help.starshipit.com).
## Error when importing WooCommerce orders
If you get an Unsuccessful 404 error when trying to import orders, you may need to check your store URL.
1. Check your domain URL with **http://**.
2. If your browser gets redirected to **https://**, test your integration with your consumer key and secret e.g. `https://www.YOURSTORE.com/wc-api/v2/orders?consumer_key=XXXXXXX&consumer_secret=XXXXXXX`
3. If you can see a list of orders, go to your Starshipit account > **Settings** > **Integrations** > **WooCommerce**.
4. In the **URL** field, change your URL to start with **https://**.
5. Test to ensure the connection works. You should get a successful result. If you continue to receive an error, please contact our [support team](https://help.starshipit.com).
6. If you get a successful result with the above test but the connection in Starshipit is stating unsuccessful, please disable **Bot Fight Mode** with your CloudFlare in WooCommerce.
## Error: Unsuccessful - The underlying connection was closed: The connection was closed unexpectedly
If you test the connection and get this error, add the following content into the **Custom Request Headers** field:
```
user-agent: Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/72.0.3626.119 Safari/537.36
```
## Error: Writeback failing with 401 error
This means that we do not have the proper authentication to update your orders. Try ticking the **Use consumer key and secret as query string parameters** option. This usually bypasses many of the security/firewall issues a server may be having with processing the authorisation.
## Error: Writeback failing with 403 error
This means we do not have the proper permissions to update your orders in your store. Make sure the API key has both read and write permissions.
Also ensure that the user you have assigned is a stand alone user with admin permissions.
## Error: Unsuccessful - Unexpected character encountered while parsing value
This can occur if your store domain name is incorrect.
1. In Starshipit, navigate to **Settings** > **Integrations** > **WooCommerce Settings**.
2. Under the URL field, make sure that your store domain starts with http or https (e.g. `https://yourstore.com`).
3. Remove any trailing paths e.g. `https://yourstore.com/shop/`
---
# Connect Xero to Starshipit
URL: https://support.starshipit.com/articles/203826239-connect-xero-to-starshipit
Canonical: https://support.starshipit.com/articles/203826239-connect-xero-to-starshipit
Markdown: https://support.starshipit.com/articles/203826239-connect-xero-to-starshipit.md
Updated: 2026-05-06
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Learn how to integrate Starshipit with Xero so your orders import directly from Xero.
:::note
Starshipit will not write back in Xero
:::
## Integrate your Xero platform in Starshipit
1. In Starshipit, navigate to **Settings** > **Integration**
2. Click on **Add new integration** and select Xero from the list.
3. Click on the **Authorize** button
4. Log in to your Xero account to authorize Starshipit.
5. After you have finished authorisation, click **Save**. You can update the integration settings later from **Settings > Integrations**.
## Importing Xero address fields
The address format in Xero must follow one of the rules below in order to have the address imported to the correct fields in Starshipit:
1. When address has 2 lines in Xero
* Address Line 1 > Street
* Address Line 2 > Suburb
2. When address has 3 lines in Xero
* Address Line 1 > Building
* Address Line 2 > Street
* Address Line 3 > Suburb
:::note
Country field needs to be filled in Xero for the "State/Region" to be imported properly. e.g. "Australia", "United States".
:::
## Configure Xero settings
| Setting | What it does |
| --- | --- |
| **Authorize** | Signs in to Xero and grants Starshipit access to the selected Xero organisation. |
| **Remove tokens** | Revokes the saved Xero authorisation in Starshipit. Authorise again before importing orders. |
| **Delivery address** | Chooses whether Starshipit uses the Xero **Street Address** or **PO Address** for the destination address. |
| **Organization to import** | Selects the Xero organisation or tenant from which Starshipit imports orders. |
| **Status to import** | Sets the Xero status filter used when importing orders. |
Save after changing the delivery address, organisation, or status, then use **Test connection** to confirm access.
---
# Connect Zapier to Starshipit
URL: https://support.starshipit.com/articles/360001414896-connect-zapier-to-starshipit
Canonical: https://support.starshipit.com/articles/360001414896-connect-zapier-to-starshipit
Markdown: https://support.starshipit.com/articles/360001414896-connect-zapier-to-starshipit.md
Updated: 2026-05-06
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Learn how to use Zapier to connect different apps and platforms to Starshipit.
## What you need to know
Zapier is a workflow automation tool which allows you to connect different apps, platforms and services together (4,000+ are supported).
By connecting Zapier and Starshipit, you can create workflows that trigger based on different events. You can create these workflows without needing to enter a line of code and automate common day-to-day tasks.
There are three important Zapier terms to understand:
* **Zap:** Automated workflows which connect your apps and services together. Zaps are made up of a trigger and then one or more actions. When you turn your Zap on, it will run the action steps when the trigger occurs.
* **Trigger:** An event that starts a Zap. Once you’ve created a Zap, Zapier monitors for these triggers. Let’s say you want to set up a Zap to send Shopify orders to Starshipit once they’ve been paid. In this case, the trigger is the Shopify order being paid.
* **Action:** An event that’s performed when the trigger occurs Using the Shopify example, the action is the paid Shopify order being automatically sent to Starshipit.
You can learn more about how Zapier works with the [Zapier quick-start guide.](https://zapier.com/learn/zapier-quick-start-guide/) Or, read our blog on using Zapier with Starshipit.
## What you need to get started
You’ll need a Starshipit account and a Zapier account to use them together.
* Sign up for [Zapier](https://zapier.com/sign-up)
* Sign up for [Starshipit](https://starshipit.com/free-trial)
## Set up Zapier and Starshipit
1. Log in to your [Zapier account.](https://zapier.com/app/login?_ga=2.144662972.868474051.1646615388-1538484001.1646615388)
2. Navigate to **My Apps** from the side menu bar.
3. Click on **Connect a new account** and search for Starshipit.
4. Enter your **Starshipit API key** to connect your account to Zapier.
You can find your Starshipit API key in the Starshipit app under **Settings** > **API**.
5. Once you've connected Starship with Zapier, you can create your first automation. Use a pre-made Zap or create your own with the Zap Editor. Creating a Zap requires no knowledge of coding and you'll be guided step-by-step through the setup.
:::note
Need some inspiration? See everything that's possible with Starshipit and Zapier.
:::
## Use cases
### Set up label and packing slip printing
You can use Zapier to set up a trigger and action in Starshipit so that as soon as an order is created in your eCommerce platform, a label gets printed. You’ll find a [step-by-step guide in our Changelog](https://starshipit.canny.io/changelog/zapier-label-and-packing-slip-printing).
### Customise how you push new paid Shopify orders to Starshipit
Starshipit already imports orders from Shopify automatically, but with Zapier you can customise how the order is pulled through. For example, you may have specific field mapping requirements, or might want to add your own dimensions.
### Create an order in Starshipit when a new row is added to your spreadsheet
If you're using a spreadsheet to manage new orders, automate the job of adding orders to Starshipit by using this Zapier workflow.
---
# Connect Zeald to Starshipit
URL: https://support.starshipit.com/articles/203826599-connect-zeald-to-starshipit
Canonical: https://support.starshipit.com/articles/203826599-connect-zeald-to-starshipit
Markdown: https://support.starshipit.com/articles/203826599-connect-zeald-to-starshipit.md
Updated: 2026-05-06
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Integrate your Zeald platform with Starshipit to import orders and write back tracking information when you print labels.
Integrate your Zeald platform with Starshipit to import orders and write back tracking information when you print labels.
## Set up
1. In Starshipit, navigate to **Settings** > **Integration**.
2. Click **Add a new integration** and select Zeald from the list of integrations.
3. Tick **Enable Zeald**.
4. Enter your store name, Zeald key, and website URL.
5. Click **Save**.
## Configure Zeald settings
| Setting | What it does |
| --- | --- |
| **Enable Zeald** | Turns the integration on or off. |
| **API key** | Authenticates Starshipit with Zeald. Keep it private. |
| **Website name** | Identifies the Zeald website connected to Starshipit. |
| **Status to import** | Sets the Zeald order status Starshipit imports. |
| **Enable writeback** | Sends shipment and tracking information back to Zeald after fulfilment. |
Save the settings and use **Test connection** before relying on automatic imports.
---
# Connect Zoho to Starshipit
URL: https://support.starshipit.com/articles/12101656036879-connect-zoho-to-starshipit
Canonical: https://support.starshipit.com/articles/12101656036879-connect-zoho-to-starshipit
Markdown: https://support.starshipit.com/articles/12101656036879-connect-zoho-to-starshipit.md
Updated: 2026-07-21
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Connect Zoho Inventory to Starshipit and configure data centre, order import, and write-back settings.
Integrate Starshipit with Zoho Inventory to import orders into Starshipit and write shipment details back to Zoho after fulfilment.
## Before you begin
Make sure you have:
* A Zoho Inventory account.
* Admin access to your Starshipit account.
* Access to the Zoho organisation you want to connect.
* The Zoho data centre for your Zoho account.
:::important
Select the Zoho data centre that matches where your Zoho account is hosted before you authorise Zoho. This may differ from your business location. If Zoho redirects with `location=us` or `accounts-server=https://accounts.zoho.com`, choose **United States (US)**.
:::
## Connect Zoho
1. In your Starshipit account, go to **Settings > Integrations**.
2. Click **Add a new integration** and select **Zoho**.
3. Turn on **Enable Zoho**.
4. Choose the **Data Centre** for your Zoho account.
5. Click **Authorize** and sign in with your Zoho account.
6. Wait for Starshipit to return to the Zoho settings page.
7. Select the **Organization To Import From**.
8. Select the **Location To Import From**, if required.
9. Choose the **Import Stage** for orders to import.
10. Click **Save**.
After saving, click **Test connection** to confirm Starshipit can connect to Zoho.
## Configure Zoho settings
Use these settings to control Zoho imports and shipment write-back.
| Setting | What it does | When to use it |
| --- | --- | --- |
| **Enable Zoho** | Turns on the Zoho integration. | Enable this when you want Starshipit to import orders from Zoho. |
| **Import orders using Zoho Packages** | Uses Zoho Packages as the import source and imports only **Not Shipped** packages. | Recommended for Zoho warehouse workflows. Leave this off to import sales orders. |
| **Write back sales order shipment details to Zoho** | Writes sales order shipment details, including tracking numbers, back to Zoho after fulfilment. | Enable this when fulfilled shipments should update Zoho sales orders. Zoho requires at least one package before a shipment order can be created. |
| **Send shipment number to Zoho** | Sends shipment numbers when Starshipit creates Zoho shipment orders. | Disable this if Zoho should auto-generate shipment numbers. |
| **Data Centre** | Sets the Zoho data centre Starshipit uses for authorisation and API requests. | Match your Zoho account domain, such as **Australia (AU)** for `.com.au` or **United States (US)** for `.com`. |
| **Organization To Import From** | Sets the Zoho organisation Starshipit imports orders from. | Select the organisation you want to connect to Starshipit. |
| **Location To Import From** | Sets the Zoho location Starshipit imports orders from. | Use this if your Zoho organisation has multiple locations and you only want to import orders from one location. |
| **Import Stage** | Sets the order status Starshipit imports from Zoho. The default is `DRAFT`. | Choose the status that matches the orders you want to fulfil in Starshipit. |
## Use Zoho custom fields in rules
Starshipit imports populated Zoho sales-order custom fields as order tags. Each tag uses the format `Zoho: Field name = value`.
You can use these tags in a business rule. For example, to route orders with a Zoho field named `Route Group` and a value of `North` to a child account:
1. In Starshipit, go to **Settings > Rules**.
2. Create a rule with the **Tags** condition matching `Zoho: Route Group = North`.
3. Choose **Assign To Another Account** as the action.
4. Select the child account, then click **Save**.
Import a test order and check its tags before relying on the rule. See [Rules overview](/articles/115001575803-rules-overview) for more ways to automate imported orders.
:::important
If you enable **Import orders using Zoho Packages** or **Write back sales order shipment details to Zoho**, re-authorise Zoho so Starshipit can request the required Zoho package or shipment permissions.
:::
## Verify the connection
After you save the integration:
1. Click **Test connection**.
2. Confirm the connection test succeeds.
3. Click **Fetch latest orders**.
4. Check that orders import into Starshipit.
5. Open a test order and confirm the order details match Zoho.
6. If write-back is enabled, fulfil a test shipment and confirm the shipment details appear in Zoho.
## Troubleshooting
### Authorisation failed or the organisation list is blank
Check that the **Data Centre** in Starshipit matches the data centre returned by Zoho during authorisation.
For example:
* If Zoho returns `location=us` or `accounts-server=https://accounts.zoho.com`, select **United States (US)**.
* If you access Zoho from a `.com.au` domain, select **Australia (AU)**.
After changing the **Data Centre**, click **Authorize** again and sign in with Zoho.
### Orders are not importing
Check the following:
* **Enable Zoho** is turned on.
* The correct **Organization To Import From** is selected.
* The correct **Location To Import From** is selected, if your Zoho account uses locations.
* The **Import Stage** matches the status of the orders you expect to import.
* If **Import orders using Zoho Packages** is enabled, the packages are in **Not Shipped** status.
### Shipment details are not writing back to Zoho
Check the following:
* **Write back sales order shipment details to Zoho** is enabled.
* Zoho has at least one package on the sales order.
* Zoho has been re-authorised after enabling write-back.
* **Send shipment number to Zoho** is disabled if Zoho is set to auto-generate shipment numbers.
## Update Zoho settings
1. In **Settings > Integrations**, select **Zoho settings**.
2. Update the settings you need to change.
3. Click **Save**.
---
# Product Catalogue
URL: https://support.starshipit.com/articles/6817931777807-product-catalogue
Canonical: https://support.starshipit.com/articles/6817931777807-product-catalogue
Markdown: https://support.starshipit.com/articles/6817931777807-product-catalogue.md
Updated: 2026-08-18
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Store product details like SKU, HS code, cost price, and bin location in Starshipit to automatically fill missing order information and improve shipping compliance.
The Product Catalogue in Starshipit lets you store all relevant product details — such as SKU, HS/HTS code, cost price, and bin location — and automatically apply them to orders during import or at checkout. This means less manual data entry, better customs compliance, and more accurate live shipping rates.
## What you can do with the Product Catalogue
Want to pick and pack from Starshipit, but need to specify where items are stored?
Use the Product Catalogue to specify the location of each item. This information will be printed on packing slips and displayed in the UI for easy access.
Missing item dimensions when creating packages?
Specify the dimensions of each product, and configure your packages based on these item dimensions. See the Packages Setup Guide for more information.
Shipping internationally and missing crucial customs details like HS codes and country of origin?
Configure these in the Product Catalogue, and we'll ensure they're automatically submitted to the courier with your shipment.
Is the item name on your storefront causing delays at customs?
Set a customs description for your items in the Product Catalogue. Starshipit will use that description — rather than the storefront name — when you ship your orders.
Don't have item weights loaded in your platform?
Set the weights in Starshipit so your shipping quotes are accurate and acceptable to your couriers.
Want accurate live rates at checkout?
Starshipit can use matching Product Catalogue data when it calculates live checkout rates for **Shopify**, **BigCommerce**, **Tiendanube**, and **Wix**. Enable the Product Catalogue for checkout and make sure each checkout item has a SKU that matches a catalogue product. Other ecommerce platforms can still use Product Catalogue data during order import, but are not supported by this live-checkout setting. See [Configure Product Catalogue settings](/articles/1781620000002-configure-product-catalogue-settings) for setup details.
Shipping to the United States and need correct tariff codes for customs?
Add an HTS Code to your products in the Product Catalogue. Starshipit will automatically use this for shipments to the U.S., ensuring your items are classified correctly for duty and tariff calculation.
Managing B2B2C shipments where you can't declare retail prices?
Include the Cost Price for your products and enable the B2B2C setting in Product Catalogue settings. Starshipit will then use the Cost Price as the declared value for U.S. shipments, helping you stay compliant and protect wholesale pricing.
## How it works
1. **Load your products into Starshipit**
Add products to the Product Catalogue manually or via CSV import. Include details like SKU, weight, dimensions, HS code, and any other shipping-related fields.
2. **SKU matching during order import and checkout**
* **During order import:** Starshipit checks for matching SKUs between the incoming order items and the Product Catalogue.
* **On checkout (live rates enabled):** Starshipit references the Product Catalogue to complete or replace missing product information — like dimensions or weights — before calculating rates.
3. **Settings control how data is applied**
Based on your settings, Starshipit will either replace all product fields with catalogue data, or only fill in fields that are empty.
4. **Order or checkout is completed with accurate data**
The order or live rate request is processed using complete, validated product data from the catalogue.
## Next steps
* [Add and manage products in the Product Catalogue](/articles/integrations/product-catalogue/add-and-manage-products-in-the-product-catalogue) — learn how to add products manually, edit them, and import via CSV.
* [Configure Product Catalogue settings](/articles/integrations/product-catalogue/configure-product-catalogue-settings) — control how and when Starshipit applies catalogue data to your orders and checkout.
* [Developer center](/developers) — start here if you are building against one of Starshipit's APIs.
---
# Add and manage products in the Product Catalogue
URL: https://support.starshipit.com/articles/1781620000001-add-and-manage-products-in-the-product-catalogue
Canonical: https://support.starshipit.com/articles/1781620000001-add-and-manage-products-in-the-product-catalogue
Markdown: https://support.starshipit.com/articles/1781620000001-add-and-manage-products-in-the-product-catalogue.md
Updated: 2026-06-16
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Add products to the Starshipit Product Catalogue manually or by importing a CSV file, then edit or update them at any time.
Add products to the Product Catalogue manually or by importing a CSV file. Once products are loaded, Starshipit can automatically apply their details — like weight, dimensions, and HS code — to matching orders during import or at checkout.
## Add a new product
1. In your Starshipit account, go to **Settings > Product Catalogue**.
2. Click **Add new product manually**.
3. Enter the product details, including SKU, bin location, HS code, and any other necessary fields.
4. Click **Save**.
1. In your [Starshipit](https://app2.starshipit.com/) account, select **Products** from the left menu.
2. Click **Add New**.
3. Enter your product details.
4. Click **Save**.
## Edit a product
1. Select **Products** from the left menu.
2. Locate the product you want to edit by searching in the search field or scrolling to the product row.
3. Click on the specific field you want to update within the product row.
4. Update the value and save by pressing **Tab** or clicking elsewhere on the page.
:::note
If the field you want to update is not visible, click the cog icon to show or hide columns.
:::
## Import products using a CSV file
**CSV requirements**
* Each product must be on a separate line.
* Each SKU must be unique — treat each product variant as its own SKU.
* Avoid commas in any field.
**How to import**
1. Go to **Settings > Product Catalogue**.
2. Under **Import from CSV file**, click **Select** and choose your CSV file.
3. Click **Upload**.
#### Watch the video
**CSV requirements**
* Each product must be on a separate line.
* Each SKU must be unique — treat each product variant as its own SKU.
* Avoid commas in any field (e.g. "Shirt, with pants" will cause an error).
* Enter dimensions in metres (e.g. `0.25` for 25 cm).
* You must use the preformatted CSV template. Download it from the import modal.
**How to import**
1. Select **Products** from the left menu.
2. Click **More actions**.
3. Click **Import CSV file**.
4. Click **Browse** and choose your CSV file.
5. Click **Upload**.
## FAQs
**How should I handle product variants?**
Add each variant as a separate SKU in the Product Catalogue.
**Can I use the Product Catalogue for bin locations if my eCommerce platform doesn't import them?**
Yes. Upload a CSV with SKUs and bin locations. Starshipit will match SKUs and apply the bin locations during order import.
**Why would I use Starshipit's Product Catalogue over Shopify's?**
Starshipit's Product Catalogue is designed to enhance Shopify's, not replace it. It lets you optimise product data specifically for fulfilment — for example, setting a different customs description to improve customs clearance, adding bin locations to simplify packing, or including dimensions for optimal packaging. It bridges the gap between the products you sell and the most efficient way to pick, pack, and ship them.
**What happens if I import a CSV with SKUs that already exist?**
Starshipit replaces the existing values with those in the import file.
**What if my CSV has duplicate SKUs?**
The first occurrence is imported. Subsequent duplicates are ignored and flagged as errors.
**Do you have APIs available for the Product Catalogue?**
Yes. Starshipit provides Product Catalogue APIs for syncing and automating with other systems. See the [Product Catalogue API reference](/developers/api-reference/starshipit/products) for details.
## Related articles
* [Product Catalogue](/articles/integrations/product-catalogue/product-catalogue) — overview, use cases, and how it works.
* [Configure Product Catalogue settings](/articles/integrations/product-catalogue/configure-product-catalogue-settings) — control how Starshipit applies catalogue data to orders and checkout.
---
# Configure Product Catalogue settings
URL: https://support.starshipit.com/articles/1781620000002-configure-product-catalogue-settings
Canonical: https://support.starshipit.com/articles/1781620000002-configure-product-catalogue-settings
Markdown: https://support.starshipit.com/articles/1781620000002-configure-product-catalogue-settings.md
Updated: 2026-06-16
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Control how Starshipit uses the Product Catalogue to populate product data during order import and at checkout.
Product Catalogue settings control when and how Starshipit applies your product data to orders during import and to live rate requests at checkout. All settings are in **Settings > Product Catalogue**.
## Settings reference
| Setting | What it does |
|---|---|
| **Enable Product Catalogue for order import** | Master switch. When enabled, Starshipit uses the Product Catalogue to populate product data on matching SKUs during order import. Uncheck to disable all automatic data population. |
| **Override all values** | Replaces all product fields in incoming orders (or checkout requests) with catalogue data whenever SKUs match. |
| **Only populate missing values** | Only fills in fields that are empty in the incoming order or checkout request. Existing values are not overwritten. |
| **Add items when importing orders** | Automatically creates a new Product Catalogue entry for any SKU in an imported order that doesn't already exist in the catalogue. |
| **Prevent populating if value is empty or 0** | Only populates a field if the catalogue entry contains a valid value greater than zero. Prevents blank or zero values from overwriting data during import or checkout. |
| **Use cost price for USA shipments (B2B2C)** | Uses the product's Cost Price as the declared value for shipments to the United States instead of the retail price. Requires **Override all values** to be enabled. |
| **Use on checkout** | Applies catalogue data (dimensions, weights, values) when calculating live shipping rates at checkout. Behaviour is controlled by the Override/populate-missing setting. |
:::note
**Override all values** and **Only populate missing values** are mutually exclusive — enabling one disables the other.
:::
## When to use each setting
**Override all values** is the right choice when your Product Catalogue is the single source of truth for shipping data. Any values that come in from your eCommerce platform will be replaced.
**Only populate missing values** is safer when your platform already provides some product data (like weight or dimensions) and you only want Starshipit to fill the gaps.
**Prevent populating if value is empty or 0** is useful when your catalogue may have incomplete entries — it ensures Starshipit won't inadvertently overwrite real order data with blanks or zeroes.
> Leave **Prevent populating if value is empty or 0** off if you intentionally want to overwrite existing values with blanks or zeros from your eCommerce platform.
## FAQs
**How does the "Only populate missing values" setting interact with HS Code rules?**
HS Code rules take precedence over Product Catalogue settings. If an HS Code rule applies to an order, it will override any HS code set in the Product Catalogue, regardless of the populate setting.
**Can I use the Product Catalogue on checkout for live rates?**
Yes. Enable **Use on checkout** to have Starshipit reference the Product Catalogue when calculating live shipping rates. Starshipit will use product dimensions, weights, and values from the catalogue to ensure accurate rate calculations. The Override/populate-missing setting controls whether catalogue data replaces or supplements the data provided at checkout.
**Does the B2B2C cost price setting apply to all shipments?**
No — it only applies to shipments destined for the United States. For all other destinations, the retail price is used as the declared value. **Override all values** must also be enabled for this setting to take effect.
## Related articles
* [Product Catalogue](/articles/integrations/product-catalogue/product-catalogue) — overview, use cases, and how it works.
* [Add and manage products in the Product Catalogue](/articles/integrations/product-catalogue/add-and-manage-products-in-the-product-catalogue) — add products manually or via CSV import.
---
# Set up packages and import weights and dimensions
URL: https://support.starshipit.com/articles/206705413-set-up-packages-and-import-weights-and-dimensions
Canonical: https://support.starshipit.com/articles/206705413-set-up-packages-and-import-weights-and-dimensions
Markdown: https://support.starshipit.com/articles/206705413-set-up-packages-and-import-weights-and-dimensions.md
Updated: 2026-06-23
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Step-by-step guide to setting up packages and import weights and dimensions.
Create a set of predefined boxes to use daily and automate your shipping processes. You can also automatically import the weight of an order item from certain eCommerce platforms.
{{video:youtube:O9WN-etlvng}}
## How it works
You can save time in your fulfilment process by using predefined packages. This will save you time when you print your labels. Orders are automatically allocated to the correct box and labels are created without having to manually enter in dimensions or weight for each item.
You can set up boxes based on a combination of your courier rates, and the size and/or weight of what you ship. You can also create boxes for Flat Rates, Dead Weights, Satchels or commonly used boxes.
:::warning
Changing the set-up of your box can result in extra charges by courier companies. Please ensure you enter the correct information when you set your boxes up. If you are unsure, talk to your Account Manager for more information based on your business needs.
:::
## 1\. Set up your boxes
Enter one or more preset boxes to select during the shipping process.
1. In [Starshipit](https://app2.starshipit.com/), go to **Settings** \> **Package Setup** (Classic UI)/**Packaging** (UI 2.0).
2. Click **Add a new box**.
3. Enter the required information. See the box properties table below for reference.
4. Click **Save**.
### Box properties
| Property | Description |
| -------- | ----------- |
| **Name** | The name of the box as it appears on labels and in the package list. Your business may have a box naming system already which you can replicate here. |
| **Weight** | Weight of the box using your set weight unit which is kilograms by default. Use this if your boxes always weigh the same amount. To configure your weight unit go to **Settings** \> **Options** and select from the **Display Weight Unit** dropdown. |
| **Make this the default package** | Select this option to make this the default package size. This box will be selected each time you open the shipping screen. |
| **Height, Length, Width** | Height, length, and width of the box in centimetres by default. Used to calculate box volume for billing. To configure your dimensions unit go to **Settings** \> **Options** and select from the **Display Sizes Unit** dropdown. |
| **Unit Type** | Select the type of package e.g. carton, satchel, or bag. |
| **Add packaging weight to your box** | Allows you to specify the weight of the packaging material. This weight will be added on top of the box weight when shipping. Only use if your packaging material adds a significant amount of weight e.g. wooden crates. |
| **Add minimum & maximum weight to your box** | Specify the min and max weight that can go into each box. If the order is within that weight range it will be automatically assigned to that package when the order is imported. |
## 2\. Import weights and dimensions from your integrated platform
Set your account to import item weights and dimensions from supported eCommerce platforms. Shopify can provide dimensions on imported orders when product dimension metafields are configured.
Importing weight is supported with most platforms. Dimensions are supported with:
* Magento2
* Cin7
* DEAR
* WooCommerce
* Peoplevox
* Shopify, when [product dimensions metafields](/articles/integrations/shopify/shopify-import-optional-data#product-dimensions-metafields) are configured for imported orders
1. Go to **Settings**, then select **Package Setup**.
2. Select one of the below options, then click **Save**.
| Option | Description |
| ------ | ----------- |
| **Single Package using sum of item weights** | All items are packed into one shipment. The total weight is based on the items in the order, and the dimensions come from your default package. |
| **Single Package using sum of item weights and integration item dimensions** | All items are packed into one shipment. Both the weight and dimensions are calculated from the imported item data. Saved packages are not used. |
| **Single Package using default package weight and default package dimensions** | Every order uses your selected default package weight and dimensions, no matter what item data is imported. |
| **Single Package using default package weight and integration package dimensions** | All items are packed into one shipment. The weight comes from your default package, while the dimensions come from the imported item dimensions. |
| **Unique Package for each item using integration item weights and integration item dimensions** | Each item is shipped as its own package using its own weight and dimensions. Saved packages are not used. |
| **Automatically assign packages based on item dimensions** | The system automatically chooses the smallest saved package that fits the items based on their dimensions. It can use more than one package if needed. |
### How to choose the right option
| Option | Best for | Notes |
| ------ | -------- | ----- |
| **Single Package using sum of item weights** | Stores that use one standard box size but have different order weights, like clothing or small goods. | Fastest default option for accurate total weight. |
| **Single Package using sum of item weights and integration item dimensions** | Stores with accurate item weights and dimensions. | Requires item dimension support from your integration. |
| **Single Package using default package weight and default package dimensions** | Stores that always ship using the same box or satchel. | Uses your default package values for every order. |
| **Single Package using default package weight and integration package dimensions** | Stores with a fixed packaging weight but different item sizes. | Requires package dimensions from your integration. |
| **Unique Package for each item using integration item weights and integration item dimensions** | Pre-packed, bulky, or individually shipped items. | Requires item weight + dimension support from your integration. |
| **Automatically assign packages based on item dimensions** | Automatically choosing the right package, including multi-package shipments. | Requires accurate item dimensions to produce reliable results. |
:::note
Any option that references integration dimensions depends on your platform/integration supplying those dimensions.
:::
:::note
When importing weights, Starshipit will apply a total weight to the order. This total weight is the combined weight of all the items in the order. This feature requires an eCommerce platform that allows for item weights to be added to the system.
:::
---
# Set up USB scales
URL: https://support.starshipit.com/articles/6530818242831-set-up-usb-scales
Canonical: https://support.starshipit.com/articles/6530818242831-set-up-usb-scales
Markdown: https://support.starshipit.com/articles/6530818242831-set-up-usb-scales.md
Updated: 2026-07-20
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Connect and enable a supported USB scale in the Starshipit Desktop Print Application.
Set up a supported USB scale so Starshipit can read package weights while your team processes orders.
## Before you begin
You need:
- Windows or macOS.
- The latest [Starshipit Desktop Print Application](/articles/360000693156-set-up-desktop-print-application).
- A supported Dymo M10, M25, or S50 USB scale.
The integration records weights in kilograms. Contact Starshipit support before purchasing another scale model for this workflow.
## Connect the scale
1. Install and connect the scale using the manufacturer's instructions.
2. Open the Starshipit Desktop Print Application.
3. Open its settings window.
4. Select **Peripherals**.
5. Enable **Scale**.
6. Select your scale model.
7. Click **Save**.
## Verify the connection
Confirm the scale status shows **Connected** in the bottom-left of the Desktop Print Application. If it shows **Disconnected**, check the USB connection and the manufacturer's setup before restarting the application.
To weigh a live shipment, see [Weigh a package using USB scales](/articles/90200000000513-weigh-a-package-using-usb-scales).
---
# Configure recommended packaging from item dimensions
URL: https://support.starshipit.com/articles/8753012178447-configure-recommended-packaging-from-item-dimensions
Canonical: https://support.starshipit.com/articles/8753012178447-configure-recommended-packaging-from-item-dimensions
Markdown: https://support.starshipit.com/articles/8753012178447-configure-recommended-packaging-from-item-dimensions.md
Updated: 2026-06-23
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Use the automatic package assignment feature to match items with optimal packaging based on dimensions, reducing waste and shipping costs while improving efficiency.
:::note
This does not factor in min and max weight options. Only item and package dimensions are taken into account.
:::
{{video:youtube:IaCbkQUnwQk}}
## How it works
Here's how this algorithm would package an order:
* The algorithm first examines the dimensions of each item in an order, using data from your Product Catalogue or the order's import details. For Shopify, imported order details can include configured Product or Product Variant dimension metafields.
* To start, the algorithm will try and pack all items in the order into a single package. If there are multiple packages that could be used, the algorithm will select the package with the least amount of empty space after the items have been packed.
* If not all items will fit into one package, the algorithm will pack as many items as possible into the first package, and then select another package for the remaining items. It will repeat this process until all items are packed.
* The chosen package(s) are assigned to the order, prefilling the correct labels and dimensions for packing.
## Set up
1. Ensure you have [set up your packages](/articles/orders-manifests-reports/orders/set-up-packages-and-import-weights-and-dimensions) with the correct dimensions in your Starshipit account.
2. Confirm that your product imports include item dimensions. You can use the [Product Catalogue](/articles/integrations/product-catalogue/product-catalogue), or for Shopify imported orders, [product dimensions metafields](/articles/integrations/shopify/shopify-import-optional-data#product-dimensions-metafields).
3. Navigate to **Settings** > **Packaging** > **Weight of Packaging** in your Starshipit account. Choose 'Automatically assign packages based on item dimensions' from the dropdown menu
Note: This setup process is essential for the feature to function correctly. It will apply to orders upon import. If you wish to apply these settings to existing orders in your 'new' tab, you will need to [delete and re-import](/articles/orders-manifests-reports/faqs/how-to-remove-re-import-orders) them for the changes to take effect.
## A note on item dimensions
To use this packaging feature, Starshipit requires dimensions for each of your items. You can use Starshipit's Product Catalogue, or a supported integration source such as Shopify dimension metafields on imported orders.
Integrated platforms which support item details:
* WooCommerce
* Magento
* Magento2 – [Read our guide](/articles/integrations/ecommerce-platforms/how-to-set-up-product-dimensions-in-magento-2)
* Cin7 Core
* Cin7 Omni
* Brightpearl
* Shopify, when product dimensions metafields are configured for imported orders
---
# Import contacts into your Address Book from CSV
URL: https://support.starshipit.com/articles/115002321486-import-contacts-into-your-address-book-from-csv
Canonical: https://support.starshipit.com/articles/115002321486-import-contacts-into-your-address-book-from-csv
Markdown: https://support.starshipit.com/articles/115002321486-import-contacts-into-your-address-book-from-csv.md
Updated: 2026-07-17
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Import contacts from a CSV file into your Starshipit Address Book using custom column mapping.
Import saved contact addresses from a CSV file into your Starshipit Address Book using custom column mapping. This imports contacts, not orders.
{{video:youtube:bICUcL2m974}}
## Before you begin
:::important
- The CSV file does not support special characters such as Äô and ¬†.
- Ensure the Street field contains a maximum of 50 characters for each listed address.
- All addresses must meet these requirements to import successfully.
:::
## Import contacts
1. In Starshipit, select **Address Book** from the dashboard.
2. Select **Import from CSV**.
3. Map each Starshipit field to the corresponding column in your CSV, or download the [CSV template](/uploads/articles/integrations/csv/import-contacts-into-starshipit-via-csv/image_10488172821263.png).
You can map fields using the column number or the column heading. We recommend using column numbers.
4. Select **Select**, then choose the CSV file from your computer.
5. Select **Import**.
## Verify the import
Return to **Address Book** and confirm that the imported contacts appear with the expected names and addresses.
---
# Set up and manage your Address Book
URL: https://support.starshipit.com/articles/90200000000404-set-up-and-manage-your-address-book
Canonical: https://support.starshipit.com/articles/90200000000404-set-up-and-manage-your-address-book
Markdown: https://support.starshipit.com/articles/90200000000404-set-up-and-manage-your-address-book.md
Updated: 2026-07-20
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Add, edit, delete, import, and export reusable contacts and delivery preferences in the Starshipit Address Book.
Set up the Starshipit Address Book to save frequently used contacts, addresses, delivery instructions, and shipping preferences.
## Before you begin
You need permission to modify the **Address Book** area. A saved contact can include:
- Name, company, email, and phone number.
- Delivery address and instructions.
- A code used to find the contact.
- A default carrier and signature-required preference where supported.
## Add a contact
1. Select **Address Book**.
2. Select **Add New**.
3. Enter the contact and address details.
4. Add an optional **Code**, delivery instruction, carrier, or **Signature Required** preference.
5. Select **Save**.
1. Select **Address Book**.
2. Select **Add new**.
3. Enter the contact and address details.
4. Add an optional **Default code**, **Default carrier**, delivery instruction, or **Signature required** preference.
5. Select **Save changes**.
Starshipit validates the address before saving it in UI 2.0. Check any highlighted required fields or address suggestions if the contact does not save.
## Edit or delete contacts
1. Select **Edit** beside a contact.
2. Update the details, then select **Save**.
3. To remove contacts, select their checkboxes and then select **Delete Selected**.
1. Open the action menu beside a contact and select **Edit**.
2. Update the details, then select **Save changes**.
3. To remove contacts, select their checkboxes and then select **Delete**.
:::warning
**Delete all addresses** permanently removes every contact and cannot be undone. Export a backup first if you might need the contacts again.
:::
## Import or export contacts
Use **Import from CSV** or **Export to CSV** in Classic UI. In UI 2.0, open **More actions** to find both options.
For column mapping and CSV limits, see [Import contacts into your Address Book from CSV](/articles/115002321486-import-contacts-into-your-address-book-from-csv).
## Verify your Address Book
Search for a saved contact by name or code, then confirm its address and delivery preferences are correct.
To use a saved contact on a live order, see [Use an Address Book contact on an order](/articles/90200000000512-use-an-address-book-contact-on-an-order).
---
# Set up default options
URL: https://support.starshipit.com/articles/206358506-set-up-default-options
Canonical: https://support.starshipit.com/articles/206358506-set-up-default-options
Markdown: https://support.starshipit.com/articles/206358506-set-up-default-options.md
Updated: 2026-05-07
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Learn how to set up default options, including default weight unit, currency, timezone, item details and city of manufacture.
{{video:youtube:tmsRbEqvClY}}
## Set up default options
In Starshipit, navigate to **Settings** > **Options**.
| Option | Description |
| --- | --- |
| **Units** | Set your importing weight to kgs, grams or lbs depending on what default weights you are importing. |
| **Display Weight Unit** | Set the unit used to display weights in the system. |
| **Display Sizes Unit** | Set the size unit of L x W x H displayed in the system. |
| **Currency** | Set this to your main currency. |
| **Display Time Zone** | Set this to your time zone. |
| **Default Item Description** | Set a generic description for the products you are shipping when setting your package description. This description may be used for customs clearance. |
| **Default Item Weight (kg)** | Set a default item weight when creating a manual shipment. |
| **Default Item Price** | Set a default item price when creating a manual shipment. |
| **HS code** | The HS code is a standardised number to designate the materials your goods are made from. Use this field to set a default for every order. |
| **Country of Manufacture** | Enter a default country of manufacture. This can be changed individually in each order. |
---
# Set account to metric or imperial measurements
URL: https://support.starshipit.com/articles/360001487316-set-account-to-metric-or-imperial-measurements
Canonical: https://support.starshipit.com/articles/360001487316-set-account-to-metric-or-imperial-measurements
Markdown: https://support.starshipit.com/articles/360001487316-set-account-to-metric-or-imperial-measurements.md
Updated: 2026-05-07
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Set your Starshipit account to import and display weights and measurements in metric or imperial units.
## How it works
When you set up your Starshipit account, the Options section lets you specify details about what you are shipping in order to automatically create the necessary documentation, or pre-populate some of the necessary fields.
Depending on the field, you can choose from kilogram, gram, pound, ounce, centimetre or inch.
You can also choose to import weights in one unit of measurement and display them in another if desired.
## Specify your options
1. In Starshipit, navigate to **Settings** > **Options**.
2. Enter the weights and measures settings you wish to use, for each action.
* Import Weight Unit: Select kilogram, gram or pound.
* Rates at Checkout Weight Unit: Select kilogram, gram or pound.
* Display Weight Unit: Select kilogram, gram, pound or ounce.
* Display Sizes Unit: Select centimetre or inch.
3. Click **Save**.
###
### **What's next?**
[Automatically import the weight of an order from certain eCommerce platforms](/articles/orders-manifests-reports/orders/set-up-packages-and-import-weights-and-dimensions).
---
# Rules overview
URL: https://support.starshipit.com/articles/115001575803-rules-overview
Canonical: https://support.starshipit.com/articles/115001575803-rules-overview
Markdown: https://support.starshipit.com/articles/115001575803-rules-overview.md
Updated: 2026-08-26
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Learn how to set up business rules in Starshipit to automate actions when orders are imported.
Starshipit can apply business rules when you import your orders. A unique action represents a rule, for example, even if you have 3 separate rules using the **Assign Tags** action, they collectively count as just one rule.
You can configure business logic using rules in Starshipit > **Settings** > **Rules**.
{{video:youtube:f_vWY2PMTL4}}
## Possible rule conditions
:::note
Two rules can share the same conditions (e.g. if the destination country is Australia, select Auspost and if the destination country is Australia, signature required = true), however, if you have two rules that share the same action, the rule that was created first will be applied first.
:::
* All Orders
* Currency
* Destination Building
* Destination Company
* Destination Contact Name
* Destination Country Code
* Destination Country Name
* Destination Post Code
* Destination Post Code - AU
* Destination Post Code - NZ
* Destination State
* Destination Street
* Destination Suburb or City
* Integration
* Item Country of Manufacture
* Item SKU
* Item Quantity
* Line Item Value
* PO Box & Parcel Locker Orders
* Shipping Description
* Shipping Method
* Store Identifier (only for Magento1 & 2)
* Shipping Zone
* Tags
* Their Reference
* Total Item Quantity
* Order Number
* Order Value
* Order Weight
## Possible rule actions
Assign Tags: Assign [Tags](/articles/orders-manifests-reports/orders/tags) to your orders
Assign To Another Account: Allows you to assign an order to a child account.
Create Return For Specified Courier: Creates a return for qualifying orders with the specified courier and service.
Create Return For Specified Courier & Contact: Creates a return for orders with the specified courier and service. Uses the specified Address Book contact as the return address.
Disable Courier Notification: Disables notifications from couriers (Note: Only works for Australia Post currently)
Do Not Ship: Marks items as already shipped (so they won't be shipped). Can also prevent orders with only qualifying items from importing.
Import Order: Allows you to specify if orders should import or not.
Open Order Dialog In Quick Print: Allows you to specify whether the Order Dialog should open or not, contrary to the selected 'Upon match' behaviour in Quick Print.
Select Cheapest Carrier/Service: See our guide [create a rule based on cheapest delivery option](/articles/notifications-branded-tracking-rules-child-accounts/business-rules/create-a-rule-based-on-cheapest-delivery-option) for further information.
Select Cheapest carrier/service out of specific carriers: Allows you to choose the cheapest option between predefined carriers and services.
Send Notification: Allows you to specify whether or not to send Starshipit branded notifications if you have them setup.
Set Authority To Leave: Enable/Disable Authority to Leave on orders.
Set Contain Battery: Enable/Disable the Dangerous Goods flag on orders.
Set Country of Manufacture: Allow you to specify the country of manufacture for items/SKUs. See [release notes](https://starshipit.canny.io/changelog/set-hs-code-country-of-manufacturer-via-the-rules) for further information.
Set Courier & Product Code: Set the courier and product code on orders.
Set Courier When No Aramex Products: When Aramax doesn't service the product for an order, assign the specified courier.
Set Create Return: Enable/Disable creating return labels to be provided alongside outbound labels.
Set GST paid per item: Applicable for [shipments to Singapore](/articles/international-shipping-compliance/country-specific-guides/singapore-gst-regulatory-requirement).
Set HS Code: Allow you to specify HS Code for items/SKUs. See [release notes](https://starshipit.canny.io/changelog/set-hs-code-country-of-manufacturer-via-the-rules) for further information.
Set Incotem: Applicable for DHL Express. Specify your Incoterm for your shipments.
Set Manufacturer Code: Assign a Manufacturer Identification (MID) Code to matching international order items. See [Set up MID codes for international shipments](/articles/international-shipping-compliance/international-shipping/set-up-manufacturer-identification-mid-codes-for-international-shipments).
Set Insurance Required: Enable/Disable Insurance on orders.
Set Invoice Declaration Text: Set the text to be displayed by item for DHL Express commercial invoices. See [release notes](https://starshipit.canny.io/changelog/rule-to-set-commercial-invoice-declaration-brexit-euuk) for further information.
Set Next Day: Applicable for Evri shipments only. Specify shipment to be delivered Next Day.
Set Non-Deliverable Action (NZ Post): Set various non-deliverable actions based on order conditions. In case of non-delivery, NZ Post will treat the order as abandoned and destroy.
Set Order Currency Code: Set the currency code of an order Please note that this does not act as a currency converter.
Set Order Value: Set order value to the specified value. Line items will automatically be adjusted to match-up with the total order value when you print a label.
Set Package Type: Assign your packages to your orders automatically.
Set Photo Required: Require photo to be captured upon delivery to show the receiver that it has been delivered to a safe location on their property.
Set Reason for Export: Applicable for DHL Express only, specify what export type should be use for your orders
Set Safe Drop: Enable/Disable Safe Drop on orders. See [delivery options for Australia Post orders](/articles/couriers/australia-post/delivery-options-for-australia-post-orders) for further information.
Set Sender Pays Duty: Enable/Disable duties and taxes to be paid by sender, on orders.
Set Shipper Tax Number: Sets the Tax Number (IOSS number) to be used for the order. See [Set up Shipper Tax Numbers](/articles/orders-manifests-reports/orders/set-up-shipper-tax-numbers) for further information.
Set Signature Required: Enable/Disable Signature Required on orders.
Set Tobacco: Mark a package with Tobacco automatically.
Split Order to Another Account By SKU: Split orders based on SKU prefixes so that items with different SKU prefixes are assigned to specific child accounts.
Split Packages By Order Item Quantity: See our guide [split packages by item quantities](/articles/notifications-branded-tracking-rules-child-accounts/business-rules/split-packages-by-item-quantity) for further information.
Split Packages By Order Weight: See our guide [split packages by order weight.](/articles/notifications-branded-tracking-rules-child-accounts/business-rules/split-packages-by-order-weight) for further information.
:::note
To set up multi-condition rules, please refer to [this article](/articles/notifications-branded-tracking-rules-child-accounts/business-rules/multi-condition-rules).
:::
## Rule set up example
The following rule triggers if:
1. The Order Value is greater than $100.
2. The Destination Country Name contains either Australia or New Zealand (separated by a semi-colon).
If these conditions are met, this triggers the action to Set Signature Required as True.
## How to test and run rules manually
Rules will normally run upon import however, you can trigger rules manually to apply to orders currently in the New section.
After setting up your business rules, navigate to **Settings** > **Rules** > **Run rules now**.
Your rules, including any new rules, will be applied to all your New orders. From here, you can check if the rules had the expected effect on your New orders.
## Examples of rules
* [Split packages by order weight](/articles/notifications-branded-tracking-rules-child-accounts/business-rules/split-packages-by-order-weight)
* [Split packages by item quantities](/articles/notifications-branded-tracking-rules-child-accounts/business-rules/split-packages-by-item-quantity)
* [Rules based on order value](/articles/notifications-branded-tracking-rules-child-accounts/business-rules/rules-based-on-order-value)
* [Rules based on postcode](/articles/notifications-branded-tracking-rules-child-accounts/business-rules/rules-based-on-postcode)
* [Rules based on destination country](/articles/notifications-branded-tracking-rules-child-accounts/business-rules/rules-based-on-destination-country)
* [Rules based on shipping method](/articles/notifications-branded-tracking-rules-child-accounts/business-rules/rules-based-on-shipping-method)
* [Rules based on weight](/articles/notifications-branded-tracking-rules-child-accounts/business-rules/rules-based-on-weight)
* [How do I allocate an order to a child account?](/articles/115001657023)
* [I only want to use Starshipit for international orders](/articles/notifications-branded-tracking-rules-child-accounts/business-rules/create-a-rule-to-only-import-international-orders)
## Watch more examples
{{video:youtube:knOze5mwgh8}}
---
# Multi-condition rules
URL: https://support.starshipit.com/articles/115004142643-multi-condition-rules-
Canonical: https://support.starshipit.com/articles/115004142643-multi-condition-rules-
Markdown: https://support.starshipit.com/articles/115004142643-multi-condition-rules-.md
Updated: 2026-05-07
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> How to create rules with more than one condition, such as allocating DHL to international orders under 2kg.
In Starshipit you can define rules with more than one condition for an action. For example, you can set a rule if you want to allocate DHL to international orders (Condition 1) with a weight under 2kg (Condition 2). Rules can have any number of conditions.
## 1. Set the first condition to your rule
1. In [Starshipit](https://app2.starshipit.com/), navigate to **Settings** > **Rules**.
2. Click **Add new rule**.
3. Use the dropdown menu to set the first condition.
## 2. Set the second condition to your rule
1. Click **Add another condition to this rule**.
2. Use the dropdown menu to set the second condition.
:::note
You can repeat this action multiple times to add more conditions.
:::
## 3. Set the action to your rule
1. Select the action using the drop-down menu.
2. Click **Save Changes**.
---
# Setting up reusable Shipping Zones
URL: https://support.starshipit.com/articles/13623440959119-setting-up-reusable-shipping-zones
Canonical: https://support.starshipit.com/articles/13623440959119-setting-up-reusable-shipping-zones
Markdown: https://support.starshipit.com/articles/13623440959119-setting-up-reusable-shipping-zones.md
Updated: 2026-05-07
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> How to create reusable Shipping Zones for postcode or region-based logic in Rules, Checkout Rate Rules, and Customise Rates.
Shipping Zones let you create reusable destination groups for postcode or region-based logic. You can reference these zones in Rules, Checkout Rate Rules, and Customise Rates, ensuring your shipping setup stays consistent and easy to maintain across your Starshipit account.
## Features
Shipping Zones provide a single source of truth for destination-based rules. When you update a zone, all linked rules and rate configurations update automatically. This reduces duplication and helps you maintain consistency across your account.
* Managed at the **parent account level**.
* Available for reference in **child accounts**.
* Supported in both the **Classic UI** and **UI 2.0**.
* Included on **all plans**.
## Setting up Shipping Zones
### Create a new zone
1. Go to **Settings > Shipping Zones > New Zone**.
2. Enter a clear name (for example, *Sydney Metro*, *North Island*, or *Rural WA*).
3. Add at least one **destination condition** using:
* **Postcodes**
* **Suburb**
* **State Codes**
* **Country**
### Destination condition formatting
* **Comma separation:** Separate postcodes with commas (e.g. `1000,1010`).
* **Exclusions:** Prefix with `!` (e.g. `!2500`).
* **Ranges:** Use a dash (`-`) for postcode ranges (e.g. `2000-2005`).
#### Example
This zone includes postcodes 0100, 1011, and all postcodes between 2000–2999, except 2500:
* `0100,1011,2000-2999,!2500`
## Using Shipping Zones
Once created, you can use zones in several areas:
* **Checkout Rate Rules:** Offer specific checkout rates for selected zones.
* **Rules:** Automate courier selection or other actions based on zone.
* **Customise Rates:** Apply margins to courier rates per zone. Ideal for region-based courier pricing. Learn more about [Customise Rates](/articles/rates-at-checkout/set-up-guides/customise-rates).
## Examples
### Example 1: Urban vs Rural
* **Zone 1: Sydney Metro** — postcodes `2000–2234`
* **Zone 2: Rural NSW** — postcodes `2235–2999`
* Use Checkout Rate Rules to offer cheaper courier options in Metro and limit options in Rural areas.
### Example 2: Country-specific courier assignment
* **Zone: NZ North Island** — country `New Zealand`, postcodes `0000–6999`
* Create a rule to automatically assign a specific service to all North Island orders.
### Example 3: Excluding postcodes
* **Zone: Melbourne Metro** — postcodes `3000–3207` with exclusions `!3058,!3060`
* Apply a flat $15 rate in Customise Rates for this zone; excluded postcodes fall back to national pricing.
## Important Considerations
* **Child Accounts:** Only parent accounts can configure or update zones, but child accounts can reference them.
* **Overlapping Zones:** An order can only match one zone. It’s assigned to the first zone (checking from the top of the table) that meets the conditions. Use Suburb and State fields for more precise targeting.
* **Postcode Ranges:** Ranges are not supported for alphanumeric postcodes. List these individually.
* **Deleting Zones:** You can’t delete a zone that’s currently used in a rule or rate.
* **Automatic Updates:** Any update to a zone automatically applies to all linked rules and rate configurations.
---
# Create a rule based on cheapest delivery option
URL: https://support.starshipit.com/articles/360001584895-create-a-rule-based-on-cheapest-delivery-option
Canonical: https://support.starshipit.com/articles/360001584895-create-a-rule-based-on-cheapest-delivery-option
Markdown: https://support.starshipit.com/articles/360001584895-create-a-rule-based-on-cheapest-delivery-option.md
Updated: 2026-05-07
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> How to create a rule based on the cheapest shipping option so orders are automatically assigned to the cheapest courier.
This article outlines how to create a rule based on the cheapest shipping option so when orders are imported into Starshipit, they're automatically assigned to the cheapest courier. This rule makes it really simple for your dispatch team to print labels without having to check the cheapest option has been selected.
You can learn more about rules [here](/articles/notifications-branded-tracking-rules-child-accounts/business-rules/rules-overview).
:::note
Pricing can only be determined based on the order weight which is imported with the order, or assigned as a default using the Starshipit packages functionality. If the address is not valid, this rule may not optimally select the courier.
:::
## Create a rule based on cheapest delivery option
1. In [Starshipit](https://app2.starshipit.com/), navigate to **Settings** > **Rules**.
2. Select **Add a new rule**.
3. Under Condition(s) select the order type that's relevant to you e.g. All Orders.
4. Under Action select **Select Cheapest Carrier/Service**.
5. Click **Save**.
6. If you already have orders in your Unshipped tab, click the **Run rules now** button to apply this new rule to these orders (if necessary).
## Troubleshooting
### I've created my cheapest carrier rule but it hasn't applied to my orders
The cheapest carrier rule only applies on import. Once you've created the rule, make sure to remove and reimport your orders so that your new rule applies. It will not apply when you click Run Rules Now
### My orders are all going with the cheapest carrier now and overwriting my other rules
The cheapest carriers rule runs in priority so it will overwrite your rules. If you would like it to exclude certain conditions (i.e not run for PO boxes) then you will need to exclude it from the rule. For example below is how you would make sure your rule didn't select PO boxes. ****
---
# Create a rule to not import certain orders
URL: https://support.starshipit.com/articles/9711307471631-create-a-rule-to-not-import-certain-orders
Canonical: https://support.starshipit.com/articles/9711307471631-create-a-rule-to-not-import-certain-orders
Markdown: https://support.starshipit.com/articles/9711307471631-create-a-rule-to-not-import-certain-orders.md
Updated: 2026-05-07
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> How to create rules to exclude certain orders from importing based on conditions like item SKU or destination country.
Create rules to exclude certain orders from importing based on certain conditions. For example, you can exclude an order containing a specific item SKU from importing.
## Common use cases
### Pre-orders
If you have any pre-orders on hold and you want to prevent them from importing, you can create the following rule:
1. In Starshipit, navigate to **Settings** > **Rules.**
2. Under Condition(s), select **Tags** and enter the tag you're using to identify your preorders.
3. Under Action, select **Import Order**.
4. Set the value as **False**.
### Exclude specific countries
For example, if you need to exclude orders from Australia and New Zealand from importing as they need to be fulfilled via an Australian warehouse when all other orders will be fulfilled from a US warehouse, you can create the following rule:
1. In Starshipit, navigate to **Settings** > **Rules.**
2. Under Condition(s), select **Destination Country Name**.
3. Enter the name of countries you want to exclude from importing.
4. Under Action, select **Import Order**.
5. Set the value as **False**.
---
# Manage orders going to PO Boxes
URL: https://support.starshipit.com/articles/360000422175-manage-orders-going-to-po-boxes
Canonical: https://support.starshipit.com/articles/360000422175-manage-orders-going-to-po-boxes
Markdown: https://support.starshipit.com/articles/360000422175-manage-orders-going-to-po-boxes.md
Updated: 2026-05-07
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Learn how to manage orders going to po boxes.
Starshipit will check your orders for you to ensure you don't accidentally send the order with a carrier that doesn't support a PO box. You can also create rules to handle PO boxes in a way that suits you.
Some couriers do not deliver to PO Boxes and so you may need to have orders with a PO Box address to go with a different courier. The only couriers that support PO Boxes are Australia Post eParcel, MyPost Business, Startrack and the Plain Label couriers. If you use any couriers not in the supported list above, you may need to update the pickup address to a residential one.
## How it works
Starshipit has implemented a logic that automatically checks the building, street, suburb and city field for the below values:
* *parcel locker;parcel-locker;po box;p.o.b.;pob;p.o. box;po-box;p.o.-box;po-box;p.o box;pobox;p-o-box;p-o box;post office box;p.o. box;po box;p/o;g.p.o box;gpo box;g.p.o. box;g-p-o box;g-p-o-box;locked-bag;locked bag; parcel collect*
If this is detected and you print with an unsupported carrier, you will be presented with an error.
## Rules
If you would like to further customise PO box logic you have a few options:
### PO Box & Parcel Locker Orders Rules Condition
There is a condition that will check to see if the PO box or parcel locker has been included in any of the address fields for you. You can then choose whichever action you would like to apply in this scenario.
1. Go to **Settings** > **Rules**.
2. Click **Add new rule**.
3. Select **PO Box & Parcel Locker Orders** as the condition.
4. Set equals to **True** or **False** depending on what you require.
5. Add your action to take e.g. Assign courier or do not import order (more info on this in [section 2](#h_01HTDYHF22EH379DMJPE1Z200Y)).
### Street, Suburb/City Rules Condition
If the above-mentioned keywords don't suit you, you can also create a custom rule by using the street rule condition
1. Go to **Settings** > **Rules**.
2. Click **Add new rule**.
3. Select **Destination Street** as the condition.
4. In the condition value field enter each possible combination for PO Boxes. You can find some common values below which are already separated by semi-colons (each value should be delimited by a semi-colon).
5. Add your action to take e.g. Assign courier or do not import order (more info on this in section 2).
Example Rule Conditions
Click one of the options below to view example rule conditions.
**PO Box and Parcel Locker**
parcel;parcel locker;parcel-locker;locker;po box;p.o.b.;pob;p.o. box;po-box;p.o.-box;po-box;p.o box;pobox;p-o-box;p-o box;post office box;p.o. box;po box;p/o;
**GPO Box and Locked bag**
g.p.o box;gpo box;g.p.o. box;g-p-o box;g-p-o-box;locked-bag;locked bag;bag;
**Combination of the above**
parcel;parcel locker;parcel-locker;locker;po box;p.o.b.;pob;p.o. box;po-box;p.o.-box;po-box;p.o box;pobox;p-o-box;p-o box;post office box;p.o. box;po box;p/o;g.p.o box;gpo box;g.p.o. box;g-p-o box;g-p-o-box;locked-bag;locked bag;bag
:::note
Rules are not case-sensitive. You can enter "PO Box" or "po box" in your rule condition, and both values would work.
:::
## 2. Common use cases
Common use cases of a rule checking for PO Boxes are detailed below:
* Assigning the orders to a different courier service (e.g. Australia Post).
* Preventing the order from importing into Starshipit.
### Assigning to another courier
:::note
To determine what each service code represents, go to **Settings** > **Couriers** and then click **Settings** next to the courier you want to check the services for.
:::
### Preventing the order from importing into Starshipit
---
# Split packages by order weight
URL: https://support.starshipit.com/articles/115000296823-split-packages-by-order-weight
Canonical: https://support.starshipit.com/articles/115000296823-split-packages-by-order-weight
Markdown: https://support.starshipit.com/articles/115000296823-split-packages-by-order-weight.md
Updated: 2026-05-07
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> How to use business rules to split orders based on total weight, creating multiple packages automatically.
You can use business rules to split your order based on the total weight of an order. For example, the total weight of your order is 14kg, and you would like each package to have a maximum weight of 1kg. Using a rule you can set Starshipit to split the order into 14 packages so when you print you'll get 14 labels.
## How to set up the rule
1. In Starshipit, navigate to **Settings** > **Rules**.
2. Select **Add a new rule**.
3. Under Condition(s) select the condition that's relevant to you, e.g. All Orders.
4. Under Action select **Split Packages By Order Weight.**
5. Enter your **Maximum Package Weight.**
6. Click **Save**.
---
# Split packages by item quantity
URL: https://support.starshipit.com/articles/115000294683-split-packages-by-item-quantity
Canonical: https://support.starshipit.com/articles/115000294683-split-packages-by-item-quantity
Markdown: https://support.starshipit.com/articles/115000294683-split-packages-by-item-quantity.md
Updated: 2026-05-07
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> How to set up a rule that prints a shipping label for each package when a customer orders multiple products.
To save time and improve efficiency, you can set up a rule that prints a shipping label for each package when a customer orders multiple products for one order but the products are already packaged separately.
## How to set up the rule
1. Go to **Settings** > **Rules**.
2. Select **Add a new rule**.
3. Under Condition(s) select the condition that's relevant to you, e.g. All Orders.
4. Under Action select **Split Packages By Order Item Quantity.**
5. Click **Save**.
---
# Rules based on order value
URL: https://support.starshipit.com/articles/115000246946-rules-based-on-order-value
Canonical: https://support.starshipit.com/articles/115000246946-rules-based-on-order-value
Markdown: https://support.starshipit.com/articles/115000246946-rules-based-on-order-value.md
Updated: 2026-05-07
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> How to create rules in Starshipit based on the value of an order, such as enabling signature required for high-value orders.
You can create rules in Starshipit based on the value of an order. For example, if you want a signature to be collected on delivery if the value of the items in the order is greater than 100 dollars, you can set up a rule to automatically enable Signature Required.
## How to set up the rule
1. In Starshipit, navigate to **Settings** > **Rules**.
2. Select **Add a new rule**.
3. Under Condition(s) select **Order Value**.
4. Under Action select the action relevant to you. e.g. Set Signature Required: True.
5. Click **Save**.
---
# Rules based on postcode
URL: https://support.starshipit.com/articles/115000259963-rules-based-on-postcode
Canonical: https://support.starshipit.com/articles/115000259963-rules-based-on-postcode
Markdown: https://support.starshipit.com/articles/115000259963-rules-based-on-postcode.md
Updated: 2026-05-07
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> How to create rules to select a specific courier for a particular list of postcodes or optimise rates by area.
Create rules to select a specific courier company for a particular list of postcodes, or optimise your rates by selecting a courier company for a specific area.
## Create rules based on postcode
1. In Starshipit, navigate to **Settings** > **Rules.**
2. Select Destination Post Code AU for Australia or Destination Post Code NZ for New Zealand.
3. Enter the list of Postcodes. Each postcode has to be separated by a semicolon.
4. Select an action to do (eg. **Set Carrier & Service code**).
5. Set the parameters of that action (eg. **Courier and Product code**).
---
# Rules based on destination country
URL: https://support.starshipit.com/articles/115000258783-rules-based-on-destination-country-
Canonical: https://support.starshipit.com/articles/115000258783-rules-based-on-destination-country-
Markdown: https://support.starshipit.com/articles/115000258783-rules-based-on-destination-country-.md
Updated: 2026-05-07
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> How to create rules based on the destination country of an order to select a specific courier.
Create a rule based on the destination country of an order, or optimise your rates by selecting a courier company for a specific area.
{{video:youtube:knOze5mwgh8}}
## Set up a rule based on destination country
1. In Starshipit, navigate to **Settings** > **Rules**.
2. Under Condition(s), Select **Destination Country Name**.
3. Enter the country or the list of countries. Each country must be separated by a semi-colon.
4. Select an action, e.g. **Set Courier & Product Code**.
5. Set the parameters of that action, e.g. **Courier and Product code**.
6. Click **Save**.
---
# Rules based on shipping method
URL: https://support.starshipit.com/articles/115000245226-rules-based-on-shipping-method
Canonical: https://support.starshipit.com/articles/115000245226-rules-based-on-shipping-method
Markdown: https://support.starshipit.com/articles/115000245226-rules-based-on-shipping-method.md
Updated: 2026-05-07
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> How to create rules in Starshipit based on the shipping method your customer selected at checkout.
You can create rules in Starshipit based on the shipping method and shipping description your customer has selected during checkout. Starshipit can use this information to allocate a specific courier and product code.
For example, if your customer selects StarTrack Express, their shipping method might be "StarTrack_Exp". You can set up a rule to automatically assign this order to StarTrack, for example: if Shipping Method = StarTrack_Exp, set up StarTrack as the courier and the product code as EXP (express).
{{video:youtube:knOze5mwgh8}}
## How to set up a rule based on the shipping method
### 1. Find the shipping method for a particular order
* Open an order from the **New** section.
* On every order, in the right-hand top corner the Shipping Method is displayed; the second field is the Shipping Description. Both can be used when setting up rules.
### 2. Set up the rule
1. In Starshipit, navigate to **Settings** > **Rules**.
2. Click **Add a new rule**.
3. Under **Conditions** select **Shipping Method**.
4. Copy and paste the shipping method referenced from [Step 1](#h_01J81BBDTV6B3WSPZFQWQ3J3SX).
5. Under Actions, select **Set** **Courier & Product Code**.
6. Select the courier and product code to be used in the rule.
**What's next?**
Find out more about [setting up rules in Starshipit](/articles/notifications-branded-tracking-rules-child-accounts/business-rules/rules-overview).
---
# Rules based on weight
URL: https://support.starshipit.com/articles/218337323-rules-based-on-weight
Canonical: https://support.starshipit.com/articles/218337323-rules-based-on-weight
Markdown: https://support.starshipit.com/articles/218337323-rules-based-on-weight.md
Updated: 2026-05-07
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> How to create rules in Starshipit based on the weight of an order to allocate a specific courier.
You can create rules in Starshipit based on the weight of the order. Starshipit can use this information to allocate a specific courier and product code. For example, you want to use a different carrier service if the weight is above 12kg.
## How to set up a rule based on weight
1. In Starshipit, navigate to **Settings** > **Rules**.
2. Click **Add a new rule**.
3. Under **Conditions** select **Order Weight**.
4. In the drop-down menu, select which comparison operator you want to use and then the value.
5. Under Actions, select **Set** **Courier & Product Code**.
6. Select the courier and product code to be used in the rule.
### Limitations
The rule based on weight are set-up for every order and you are not able to exclude a part of this order.
---
# Create a rule to only import international orders
URL: https://support.starshipit.com/articles/115000280406-create-a-rule-to-only-import-international-orders
Canonical: https://support.starshipit.com/articles/115000280406-create-a-rule-to-only-import-international-orders
Markdown: https://support.starshipit.com/articles/115000280406-create-a-rule-to-only-import-international-orders.md
Updated: 2026-05-07
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> How to set up a rule so that only international orders are imported into Starshipit.
Some customers choose to only use Starshipit to process international orders and process domestic orders outside of Starshipit. For example, if you only use Starshipit for DHL Express for international shipments, you might not want to import your domestic orders. To do this you will need to create a rule so that only international orders are imported.
## Set up the rule
1. In Starshipit, navigate to **Settings** > **Rules** > **Add a new rule.**
2. Under Condition(s), select **Destination Country Name**.
3. Enter your country of origin e.g. Australia.
4. Under Action, select **Import Order**, and set the value to **False**.
---
# Get email alerts for newly imported orders
URL: https://support.starshipit.com/articles/7211862907919-get-email-alerts-for-newly-imported-orders
Canonical: https://support.starshipit.com/articles/7211862907919-get-email-alerts-for-newly-imported-orders
Markdown: https://support.starshipit.com/articles/7211862907919-get-email-alerts-for-newly-imported-orders.md
Updated: 2026-05-07
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Learn how to set up email notifications for newly imported orders in Starshipit.
## How it works
This feature allows you to send an email notification to dedicated email addresses when new orders are imported to your Starshipit account with our auto-import function. The email notification will include the number of new orders imported to your Starshipit account and a link to the login page allowing you to fulfil your orders in record time!
To get email notifications for new orders set up, follow the below steps:
1. In Starshipit, navigate to **Settings > Integrations**.
2. Under **Import Settings**, tick **Automatically import orders from all integrations**.
3. Under **Email notifications for newly imported orders**, tick **Email notifications for imported orders**.
4. Enter the email address you would like to receive the new order notifications. You can notify multiple recipients by separating the email address' with a semicolon (;).
5. Click **Save**.
## Additional info
This feature is a great addition to your workflow if you are often away from your PC, have another team member fulfilling orders in your Starshipit account, or you ship from store and want to notify your store directly that they have new orders to fulfil.
To **unsubscribe** from these email notifications please follow the below steps:
1. Go to **Settings >** Platforms.
2. De-select **Enable notifications for imported orders**or **remove the email you would like to unsubscribe from the recipient list**.
3. Click **Save**.
---
# Configure packing slips
URL: https://support.starshipit.com/articles/360000026636-configure-packing-slips
Canonical: https://support.starshipit.com/articles/360000026636-configure-packing-slips
Markdown: https://support.starshipit.com/articles/360000026636-configure-packing-slips.md
Updated: 2026-05-07
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Learn how to configure and customise packing slips in Starshipit for your shipping workflow.
## How it works
Packing slips accompany shipments sent from your online store. They are typically printed in an A4 format and have a description of your order including a list of SKUs, item descriptions, and quantities.
To configure your Packing Slips, go to Settings, then select Packing Slips.
| | |
| --- | --- |
| | |
| Classic UI | UI 2.0 |
## Example scenario
Once the orders have been imported into Starshipit, the Warehouse Manager bulk prints the packing slips. A dispatcher takes a packing slip and collects the items listed. They scan the barcode on the packing slip to find and print the relevant label in Starshipit.
## Set up packing slip printing behaviour
There are three options to configure for packing slip printing behaviour. They include:
**Print packing slips with each label**
When enabled, Starshipit will print a packing slip out at the time you print a label for an order.
1. Go to **Settings** > **Packing Slip**.
2. Click **Configure your Packing Slips here**.
3. Scroll down and under Printing behaviour, tick the checkbox next to **Print packing slips with each label**.
4. Save your settings by clicking on **Save**.
**Display order item barcode**
Adds item barcodes (if available, otherwise a barcode is created using the item SKU) to packing slips which can be used with a pick and pack device to scan barcodes on products, and match them with the barcodes on the packing slips.
1. Go to **Settings** > **Packing Slip**.
2. Click **Configure your Packing Slips here**.
3. Scroll down and under Advanced Options, tick the checkbox next to **Display order item barcode**.
4. Save your settings by clicking on **Save**.
**Use Our Ref as order number barcode**
Uses Our Ref (Order Number) as order number barcode at the bottom of packing slips.
1. Go to **Settings** > **Packing Slip**.
2. Click **Configure your Packing Slips here**.
3. Scroll down and under Advanced Options, tick the checkbox next to **Use Our Ref as order number barcode**.
4. Save your settings by clicking on **Save**.
## Use a default packing slip
The default packing slip can be printed in two ways:
* A4 format.
* 100x150mm format.
To configure this, follow these steps:
1. Go to **Settings**, then select **Packing Slip**.
2. Click **Configure your Packing Slips here**.
3. Select your packing slip template.
4. Save your settings by clicking on **Save**.
## Customise your packing slip
You can configure your custom packing slip using the following fields:
:::note
Please make sure your packing slip template is set to **Customise your own** to see these changes.
:::
| Field | Description |
| --- | --- |
| Page Title | 'Packing Slip' is entered by default. |
| Logo | Your brand logo will appear in the top left corner of the packing slip. |
| Delivery Instructions | Delivery instructions are displayed on the label to provide clear instructions to the driver e.g. 'Please leave the parcel at the front door'. |
| Items Grid | Items can have multiple variances associated with them e.g. size, colour, and location. |
## Template editor for packing slips
You can now use the packing slip template editor, a tool that will allow you to customise packing slips to your specific needs. This editor offers the flexibility to personalize every aspect of your packing slips, from layout to content, using a range of variables that represent shipment information.
To learn more about how to use the template editor in Starshipit, check out our guide [here](/articles/printing-labels-packing-slips/packing-slips-and-summaries/configure-packing-slips-using-the-template-editor).
## Reorder packing slips and packing summaries for packing efficiency
You can now apply 'Sort Order' to your packing slip & packing summary. You may need to reorder a packing slip to improve picking efficiency in your warehouse. You can organise items based on factors such as product name, SKU or location.
1. Go to **Settings**, then select **Packing Slip**.
2. Navigate to the **Sorting** section.
3. Choose how you would like the Packing Slip & Packing Summary to be sorted.
4. Choose if you would like the sorting to be Ascending or Descending.
5. Save your settings by clicking on **Save**.
## Video Guide
{{video:youtube:V3XanCBbb84}}
#### **What's Next?**
Learn how to [scan and print your packing slips](/articles/getting-started/barcode-scanning/scan-to-open-and-print).
---
# Configure packing summaries
URL: https://support.starshipit.com/articles/90200000000514-configure-packing-summaries
Canonical: https://support.starshipit.com/articles/90200000000514-configure-packing-summaries
Markdown: https://support.starshipit.com/articles/90200000000514-configure-packing-summaries.md
Updated: 2026-07-20
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Choose and customise the packing summary used for bulk picking and packing workflows.
Configure the PDF packing summary your team uses to pick or pack multiple orders at once.
## Choose a packing summary
Go to **Settings > Packing Slip > Configure your Packing Summary here**, then choose the format that matches your workflow:
- **Items Summary** lists items across the selected orders and is intended for picking.
- **Order Summary** groups the selected orders on one document for picking and packing.
- **Order Summary with Item Barcodes** adds item barcodes for scan-based packing.
- **Customise your own item summary** uses the template editor for an item-based workflow.
- **Customise your own order summary** uses the template editor for an order-based workflow.
Use **Download sample** to compare the available formats before saving one.
## Customise the summary
In the template editor, you can:
- Change wording directly in the template.
- Remove columns your team does not need.
- Add fields using variables from the editor.
- Use `%OrderRepeaterStart%` and `%OrderRepeaterEnd%` around order-level content.
- Use `%ItemRepeaterStart%` and `%ItemRepeaterEnd%` around item-level content.
Click **Save template** when the document is ready.
## Verify the configuration
Download a sample and confirm the items, orders, barcodes, and columns appear in the intended order.
To generate the document for live orders, see [Print packing summaries](/articles/360001972155-print-packing-summaries).
---
# Configure packing slips using the template editor
URL: https://support.starshipit.com/articles/9067623250063-configure-packing-slips-using-the-template-editor
Canonical: https://support.starshipit.com/articles/9067623250063-configure-packing-slips-using-the-template-editor
Markdown: https://support.starshipit.com/articles/9067623250063-configure-packing-slips-using-the-template-editor.md
Updated: 2026-05-07
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Learn how to customise packing slips using the template editor in Starshipit, including available variables and layout options.
## Why customise packing slips
Customising your packing slips can both improve the unboxing experience for your customers and streamline your packing process. Customised packing slips can:
* Improve packing accuracy by including relevant details such as item descriptions, quantities, and special instructions.
* Design packing slips that align with your warehouse layout and product types for faster processing.
* Use custom slips to convey your brand’s identity and professionalism, leaving a lasting impression on your customers.
## Setting Up Your Custom Packing Slip
1. Go to **Settings** > **Packing Slips** and choose **Customize** using Template Editor.
2. Directly edit the text within the editor to change wording or add custom messages.
3. Utilise the variable list on the right-hand side of the editor. These variables, such as **%OrderNumber%** or **%ItemDescription%**, dynamically insert shipment-specific information when the packing slip is generated.
4. Once you're satisfied with your custom packing slip, click the **Save** button to apply your changes.
#### Variables
| | |
| --- | --- |
| **Variable** | **Description** |
| [Logo] | Upload your logo in the Packing Slip settings and then use this variable in the template to specify where it goes |
| %SenderPhoneNumber% | Sender's phone number |
| %PackageName% | Package name |
| %PackageDimensions% | Package dimensions |
| %ShippingMethod% | Shipping Method |
| %ShippingDescription% | Shipping description |
| %DestinationAddress% | Formatted Destination Address for the user |
| %ItemBarcodeValue% | Item Barcode Value |
| %ItemBarcodeTable% | Item Barcode |
| %OrderDate% | Order Date |
| %PrintedDate% | Printed Date/Time |
| %OrderNotes% | Order notes |
| %Tags% | Tags |
| %TotalNumberOfItems% | Total number of items |
| %ItemModelTable% | Items Model # |
| %ProductName% | Shipping service |
| %SenderAddress% | Sender Address |
| %CurrentDate% | Current Date |
| %OrderNumber% | Order Number |
| %XofY% | X of Y (package count) |
| %ReferenceNumber% | Reference Number |
| %Weight% | Order weight |
| %SKUS% | Formatted list of order SKU's |
| %DeliveryInstructions% | Delivery Instructions |
| %ShippingMethodDescription% | Shipping Method Description |
| [Barcode] | Order Barcode |
| %DestinationPhoneNumber% | Destination Phone Number |
| %DestinationCompanyName% | Destination Company Name |
| %ItemDescriptionTable% | Item Description |
| %ItemQtyTable% | Item Quantity |
| %ItemBinTable% | Item Bin Location |
| %ItemColourTable% | Item Colour |
| %ItemSizeTable% | Item Size |
| %ItemQtyTableOf% | Item Quantity |
| %ItemSKUTable% | Item SKU |
| %ItemHSCodeTable% | Item HS Code |
| %ItemCountryTable% | Item Country of Origin |
| %ItemWeightTable% | Item Weight |
| %ItemPriceTable% | Item Price |
| %ItemTotalTable% | Total price of all items |
| %ItemBarcodeTable% | Item Barcode Table |
| %ItemBarcodeTableValue% | Item Barcode Table Value |
## Additional tips and common edits
* For more complex edits, you can export the template to Excel, make your changes, and then re-import it back into the system.
* Highlight text and use the toolbar to adjust the font size, colour, and type for better readability and branding.
* Add or remove any data fields by including variables or deleting unwanted content from the template. You can remove full sections by removing columns
* Manage the order of items listed on your packing slips through the sorting settings (found under Settings > Packing Slip > Sorting). This feature helps in organizing the packing process according to your operational needs and preferences.
* Incorporate variables related to packaging names and dimensions to facilitate a more organized and efficient packing process. This information can be crucial for packers to select the appropriate packaging for each order, thereby improving speed and accuracy.
---
# Packing slip template library
URL: https://support.starshipit.com/articles/13382030529935-packing-slip-template-library
Canonical: https://support.starshipit.com/articles/13382030529935-packing-slip-template-library
Markdown: https://support.starshipit.com/articles/13382030529935-packing-slip-template-library.md
Updated: 2026-05-07
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Download pre-built packing slip templates from the Starshipit Template Library for use with the template editor.
## What is the Template Editor tool?
The **Customise using template editor** is an Excel-based tool that allows you to customise the layout and content of your packing slips using dynamic parameters that represent shipment data.
For more information about the editor, check out [this guide.](/articles/printing-labels-packing-slips/packing-slips-and-summaries/configure-packing-slips-using-the-template-editor)
## Templates
:::note
Please note that templates are only available in A4 portrait.Landscape and other sizes coming soon!
:::
#### Basic Packing Slip Template (A4 Portrait)
A simple layout with key order and customer details.
Contains the following parameters: Logo / Barcode / Destination Address / Order Number / Order Date / Packed Date / Shipping Method / Item Image / Item Description / Item Colour / Item Size / Item QTY / Order Notes
**Values to Replace:**
* Your Company Name
* Your website URL
**Start/End Areas:**
* Start area: A1
* End area: H29
[Download the Basic Packing Slip Template (A4 Portrait)](/uploads/attachments/templates/packing-slip/basic-packing-slip-template-a4-portrait.xlsx)
---
#### Pick and Pack Packing Slip Template (A4 Portrait)
A simple layout for picking and packing from.
Contains the following parameters: Logo / Barcode / Order Number / Order Date / Destination Address / Order Notes / Order Tags / Item Image / Item Description / Item Bin Location / Item Colour / Item Size / Item QTY / Packed* / Packed By** / Packed Date / Shipping Method
* **Packed** is an empty column where you can manually tick off items as you pack them.
** **Packed by** is an empty field where you can write who packed the order for a personalised touch.
**Values to Replace:**
* Your Company Name
* Your website URL
**Start/End Areas:**
* Start area: A1
* End area: I34
[Download the Pick and Pack Packing Slip Template (A4 Portrait)](/uploads/attachments/templates/packing-slip/pick-and-pack-packing-slip-template-a4-portrait.xlsx)
---
#### Invoice Packing Slip Template (A4 Portrait)
An invoice inspired layout including item prices and totals.
Contains the following parameters: Logo / Barcode / Destination Address / Order Number / Order Date / Shipping Method / Order Notes / Item Image / Item Description / Item Colour / Item Size / Item QTY / Item Price / Item Total Price
**Values to Replace:**
* Your Company Name
* Your website URL
**Start/End Areas:**
* Start area: A1
* End area: I28
[Download the Invoice Packing Slip Template (A4 Portrait)](/uploads/attachments/templates/packing-slip/invoice-packing-slip-template-a4-portrait.xlsx)
---
## How to upload a template to the editor
1. Download your template.
2. In Starshipit, go to **Settings > Packing Slips**, then click **Configure your Packing Slips here**.
3. Under **Select your packing slip template**, select **Customise using template editor**.
4. Under **Select your template size**, set the **Template size**, **Start area**, and **End area** shown for the template you downloaded.
5. In the template editor window, click the **folder icon** and select the `.xlsx` file you downloaded. You may need to unzip the file first.
6. Click **Save Template** below the editor window to save the template.
7. Click **Download Sample** to preview the layout with sample data.
1. Download your template.
2. In Starshipit, go to **Settings > Packing Slips**.
3. Select **New custom template editor**.
4. On the **Packing slip tab**, under **Select your template size**, set the **Template size**.
5. Under **Printable area**, enter the **Start area** and **End area** for your selected template.
6. In the template editor window, click **File**, then click the **folder icon** and select the `.xlsx` file you downloaded. You may need to unzip the file first.
7. Click **Save**.
8. Click **Download preview** at the top of the page to preview the layout with sample data.
## Frequently asked questions
**Can I create my own template and upload to the template editor?**
Yes. You can use Excel or Google Sheets to create your own template and upload into the template editor following the steps above.
**Can I save multiple templates?**
Only one packing slip template can be saved in Starshipit at a time, but you can export and save templates and re-upload when needed. To export your template from the template editor, click the **Export** button.
**There is a column in the template that I don't need, can I remove it?**
Yes. You have two options:
* Replace it with a parameter that's more relevant to your needs, or
* Remove the column entirely
To replace a parameter:
1. Select the cell you want to replace
2. On the right side of the editor, double-click the new parameter you'd like to use
This will replace the selected cell with the new value.
To remove a column:
1. Select the column you want to remove
2. Click the dropdown arrow in the top-right of the editor
3. Select **Delete cells**, then select the **column icon**
1. 
---
# Add images to packing slips and packing summaries
URL: https://support.starshipit.com/articles/10764333384719-add-images-to-packing-slips-and-packing-summaries
Canonical: https://support.starshipit.com/articles/10764333384719-add-images-to-packing-slips-and-packing-summaries
Markdown: https://support.starshipit.com/articles/10764333384719-add-images-to-packing-slips-and-packing-summaries.md
Updated: 2026-05-07
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Learn how to display product images on packing slips and packing summaries for orders from eBay, Shopify, WooCommerce, and Amazon.
### Displaying Images on Packing Slips
1. In Starshipit, navigate to **Settings > Packing Slip**.
2. Select **Configure your packing slips here**.
3. Click **Customise using template editor**.
4. In the dropdown under **Template Size**, choose **A4 Images** for a preset template that includes images.
5. To customise the packing slip, add or remove any additional properties to the A4 Images template.
Once your edits are complete, click **Save**.
### Displaying Images on Packing Summaries
1. In Starshipit, navigate to **Settings > Packing Slip**.
2. Select **Configure your packing summary here**.
3. Choose **Customise your own item summary with images** for a preset template that includes images.
4. To customise the packing summary, add or remove any additional properties to the A4 Images template.
Once your edits are complete, click **Save**.
### Image formatting
When using the **A4 Images** template or the **%ItemImage%** property, the image will automatically resize to fit the cell appropriately.
---
# Set up the Starshipit Desktop App
URL: https://support.starshipit.com/articles/360000693156-set-up-the-starshipit-desktop-app
Canonical: https://support.starshipit.com/articles/360000693156-set-up-the-starshipit-desktop-app
Markdown: https://support.starshipit.com/articles/360000693156-set-up-the-starshipit-desktop-app.md
Updated: 2026-09-03
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Install the Desktop App, connect it as a Print Client, and map received labels and documents to local printers.
Set up the Starshipit Desktop App to receive print jobs from Starshipit and send each label or document type to the correct printer on a Windows PC or Mac.
{{video:youtube:AlFxnaUhcYc}}
## Before you begin
You need:
- A Windows PC or Mac that can stay on while your team prints through it.
- Permission to install applications on that computer.
- A Starshipit login and access to the account's printing settings.
- Each physical printer installed and available in the computer's operating-system printer list.
The Desktop App uses two scopes of settings. Starshipit account settings choose which Print Client machine receives a remote job. The receiving Desktop App's local **Print Settings** choose the physical printer, PDF destination, paper size, and orientation.
If you are not sure which settings you need, read [Understand how Starshipit printing works](/articles/90200000000155-understand-how-starshipit-printing-works).
:::important
Do not run the legacy standalone Print Client and the Desktop App's Print Client connection for the same machine and account. Duplicate clients can cause jobs to be handled unpredictably.
:::
## Install the Desktop App
1. Sign in to [Starshipit](https://app2.starshipit.com/).
2. Open **Settings > Printing**.
3. Select the Windows Desktop App download.
4. Run the installer and complete its prompts. Install the required Microsoft .NET Desktop Runtime if prompted.
5. Open the Desktop App and sign in with your Starshipit login.
1. Sign in to [Starshipit](https://app2.starshipit.com/).
2. Open **Settings > Printing**.
3. Select the macOS Desktop App download.
4. Open the downloaded file and drag the Desktop App into the **Applications** folder.
5. Open the Desktop App and sign in with your Starshipit login.
If macOS reports a problem opening the app, download and install the latest version from Starshipit. You can also open **Starshipit Desktop > Check for Updates...** from the macOS menu bar.
## Map received jobs to local printers
Configure this on every computer that receives print jobs. These mappings are local to that Desktop App; changing one computer does not update another.
1. Open the **Starshipit Desktop App**.
2. Open **Printing > Print Settings**.
3. Assign each required document or label type to a printer available on this computer.
4. Set the required paper size and orientation for each mapping.
5. Save the mappings.
The Windows app may also prompt you to select a printer the first time it handles a label type.
1. Open the **Starshipit Desktop App**.
2. Select **Starshipit Desktop > Settings...** from the macOS menu bar.
3. Select the **Print Settings** tab.
4. Under **Document Defaults**, choose whether each document type prints to a printer or downloads as a PDF.
5. Select the physical printer for every document type that uses **Printer**.
6. Under **Shipping Label Type Routes**, add a more specific route when a shipping label type needs a different printer, PDF destination, paper size, or orientation.
These settings answer: “When this Desktop App receives a job, what physical printer or PDF destination should it use?” They do not choose which Desktop App receives a job started elsewhere.
## Connect the Desktop App as a Print Client
Complete this section when printing starts in Starshipit web, WMS web, Pick & Pack, or another supported Print Client workflow instead of inside this Desktop App.
### Get the authorisation code
1. Sign in to [Starshipit](https://app2.starshipit.com/).
2. Open **Settings > Printing > Advanced**.
3. Select **Add new print settings**, or select **Settings** for an existing label type.
4. Copy the authorisation code.
### Connect and name the receiving machine
The exact location of the Print Client connection controls differs between the Windows and macOS Desktop Apps.
1. Open the **Starshipit Desktop App**, then select **Printers > Print Client Settings**.
2. Paste the authorisation code.
3. Enter a machine name that staff will recognise, such as `Packing bench 1`.
4. Save the connection.
5. Confirm its status changes to **Online**.
1. Open the **Starshipit Desktop App**.
2. Select **Starshipit Desktop > Settings...** from the macOS menu bar.
3. Select the **Print Client** tab.
4. Paste the authorisation code.
5. Enter a machine name that staff will recognise, such as `Packing bench 1`.
6. Save the connection.
7. Confirm its status changes to **Online**.
The machine name identifies this receiving Desktop App. It is not the name of the physical printer.
## Route Starshipit jobs to this machine
Configure the account-level route after the Desktop App is connected and online.
1. In Starshipit, open **Settings > Printing > Advanced**.
2. Select **Add new print settings**.
3. Select a document or label type, such as **Packing Slip**.
4. Set **Print Method** to **Print Client**.
5. Under **Machine**, select the machine name configured in the Desktop App.
6. Save the route.
7. Repeat the steps for each document or label type that this machine should receive.
These settings answer: “Which Print Client machine should receive this job?” After the selected Desktop App receives it, that app applies the local printer mappings you configured earlier.
:::note
Some mobile workflows can print directly through the mobile device's system print flow, such as AirPrint. Direct device printing bypasses the Print Client and the Desktop App mappings in this guide. Starshipit WMS Mobile uses this direct-device path rather than the Pick & Pack Print Client fallback.
:::
## Verify the setup
1. Confirm the intended Desktop App shows **Online** in its Print Client connection.
2. Confirm the Starshipit route uses the expected machine name for the document or label type.
3. Confirm that machine's local Print Settings use the expected physical printer or PDF destination.
4. Reprint an existing label or another low-risk document from the Starshipit workflow your team will use.
5. Confirm the selected Desktop App receives the job and the output reaches the expected printer queue or PDF destination.
Repeat the test for each document type or special shipping-label route that uses a different printer.
## Troubleshooting
| Problem | What to check |
| --- | --- |
| The Desktop App does not receive the job | Confirm the app is **Online**, signed into the expected account, and selected as the **Machine** for that document or label type. |
| The wrong Desktop App receives the job | Change the account-level **Machine** route in Starshipit printing settings. |
| The correct Desktop App receives the job but uses the wrong printer | Change the document default or shipping-label route in that Desktop App's local Print Settings. |
| The job reaches the printer queue but does not print | Check the physical printer, driver, queue, loaded paper, size, and orientation. |
| A mobile print does not appear in the Desktop App | Confirm whether the mobile workflow used direct device printing. Direct mobile prints bypass the Desktop App. |
For more fixes, see [Troubleshoot printing](/articles/213724603-printing-troubleshooting).
## Configure optional peripherals on macOS
If you use a connected scale or dimensioner with the macOS Desktop App:
1. Open **Starshipit Desktop > Settings...** from the macOS menu bar.
2. Select the **Peripherals** tab.
3. Enable the device you want to use.
4. Select the scale or enter the dimensioner IP address.
5. Use the test button to confirm the device responds.
For more detail, see [Set up USB scales](/articles/6530818242831-use-usb-scales-to-declare-package-weights).
## Related articles
- [Understand how Starshipit printing works](/articles/90200000000155-understand-how-starshipit-printing-works)
- [Set up your printer](/articles/9171767654799-setting-up-your-printer)
- [Choose a shipping label printer and label size](/articles/360001921655-shipping-label-printers-and-label-sizes)
- [Maintain an existing legacy Print Client setup](/articles/115003720583-legacy-set-up-the-print-client)
---
# Understand how Starshipit printing works
URL: https://support.starshipit.com/articles/90200000000155-understand-how-starshipit-printing-works
Canonical: https://support.starshipit.com/articles/90200000000155-understand-how-starshipit-printing-works
Markdown: https://support.starshipit.com/articles/90200000000155-understand-how-starshipit-printing-works.md
Updated: 2026-09-03
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Learn how Starshipit routes print jobs to a Desktop App and how that app chooses the physical printer.
Starshipit printing uses two sets of settings: the originating Starshipit workflow chooses which Desktop App receives the job, then that Desktop App chooses the physical printer or PDF destination.
## How print routing works
Think of printing as two separate decisions.
| Decision | Where it is configured | What it controls |
| --- | --- | --- |
| Which Desktop App receives the job? | The printing settings for the Starshipit account or workflow that creates the print job | The Print Client machine that receives the label or document |
| What happens after the Desktop App receives it? | **Print Settings** in that Desktop App | The physical printer or PDF destination, paper size, and orientation for each document or shipping label type |
For example, your Starshipit account can route packing slips to a Desktop App named `Packing bench 1`. On that computer, the Desktop App can send packing slips to an A4 printer and shipping labels to a thermal printer.
The computer that receives the job must be on and its Desktop App must show that its Print Client connection is online. The physical printer must also be installed and available to that computer. For a Print Client route, the device that triggers the job does not need to be connected directly to the printer or share the receiving computer's local network.
## Understand the print flow
When you use a Desktop App as a Print Client, a print job follows this sequence:
1. Start a print action from a supported Print Client workflow, such as Starshipit web, Starshipit WMS web, or the Pick & Pack mobile app.
2. Starshipit creates or retrieves the label or document.
3. The originating workflow routes the job to the selected Print Client machine.
4. The Desktop App on that machine receives the job.
5. The Desktop App applies its local document default or shipping-label route.
6. The Desktop App sends the output to the mapped physical printer or downloads it as a PDF.
The available print action and destination choices depend on the workflow and your account settings. Set up and test the path your team will use before processing live orders in bulk.
## Know when the Desktop App is bypassed
Some mobile workflows can send a label directly to the mobile device's system print flow. For example, an iPhone or iPad may print to an AirPrint printer. Starshipit WMS Mobile uses direct device printing and does not use the Pick & Pack Print Client fallback.
Direct mobile printing bypasses the Print Client machine and its Desktop App mappings. The printer selected on the mobile device controls the physical output instead.
In Pick & Pack, select the Print Client workflow instead of direct device printing when you want to use a Desktop App and its mapped printers. Do not troubleshoot an AirPrint job in Desktop App Print Settings because the Desktop App never receives that job.
## Choose a setup
Use the setup that matches where your team starts printing.
| Where printing starts | What to configure |
| --- | --- |
| Inside the Desktop App on the printer's computer | Configure the physical printer mappings in that Desktop App. |
| Starshipit web or another browser-based Starshipit workflow | Connect a Desktop App as a Print Client, route the account's document types to that machine, and configure the machine's physical printer mappings. |
| Pick & Pack using a Print Client | Connect and select the receiving Print Client, then configure the receiving Desktop App's physical printer mappings. |
| Pick & Pack or WMS Mobile using the device's system print flow | Select a compatible printer on the mobile device. A Desktop App is not required for that print path. |
For the recommended Print Client path, [set up the Starshipit Desktop App](/articles/360000693156-set-up-desktop-print-application).
## Verify the complete route
Test both routing decisions before relying on the setup:
1. Confirm the receiving Desktop App shows its Print Client connection as **Online**.
2. Confirm the originating Starshipit printing settings show the expected machine for the document or label type.
3. Confirm the receiving Desktop App maps that document or label type to the expected physical printer or PDF destination.
4. Reprint an existing label or use another low-risk document to test the route without creating an unnecessary shipment.
5. Confirm the job reaches the expected Desktop App and then appears in the expected printer queue or PDF destination.
## Troubleshoot the correct part of the route
Use where the job stopped to identify which settings to check.
| What happened | Check next |
| --- | --- |
| The expected Desktop App did not receive the job | Check the selected machine, account, document-type route, and the Desktop App's **Online** status. |
| The Desktop App received the job but used the wrong printer | Check that Desktop App's local document default or shipping-label route. |
| The job reached the correct printer queue but did not print correctly | Check the printer connection, driver, queue, loaded paper, paper size, and orientation. |
| A direct mobile print did not reach the printer | Check the printer selected by the mobile device and its network or system print service. |
For more fixes, see [Troubleshoot printing](/articles/213724603-printing-troubleshooting).
## Related articles
- [Set up the Starshipit Desktop App](/articles/360000693156-set-up-desktop-print-application)
- [Set up your printer](/articles/9171767654799-setting-up-your-printer)
- [Choose a shipping label printer and label size](/articles/360001921655-shipping-label-printers-and-label-sizes)
---
# Uninstall the legacy Print Client
URL: https://support.starshipit.com/articles/360001598355-uninstall-the-legacy-print-client
Canonical: https://support.starshipit.com/articles/360001598355-uninstall-the-legacy-print-client
Markdown: https://support.starshipit.com/articles/360001598355-uninstall-the-legacy-print-client.md
Updated: 2026-05-07
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Learn how to uninstall the legacy Print Client from Windows 10 and Mac.
Use these steps to remove the standalone legacy Print Client. For current automatic printing, install the Desktop App and use its Print Client connection. See [Understand how Starshipit printing works](/articles/90200000000155-understand-how-starshipit-printing-works).
## Uninstall Print Client for Windows 10
1. Select the **Start** button, then select **Settings**> **Apps**> **Apps & features**.
2. Search for Print Client in the list, and select it.
3. Click **Uninstall**.
4. Follow the prompts until a window pops up called **Starshipit Print Client Maintenance**.
5. Select **Remove the application from this computer**, and click **OK**.
## Uninstall Print Client for Mac
1. Go the **Applications** folder on your Mac.
2. Right-click on the Print Client.
3. Select **Move to bin**.
---
# Find your computer name for the legacy Print Client
URL: https://support.starshipit.com/articles/4551686247695-find-your-computer-name-for-the-legacy-print-client
Canonical: https://support.starshipit.com/articles/4551686247695-find-your-computer-name-for-the-legacy-print-client
Markdown: https://support.starshipit.com/articles/4551686247695-find-your-computer-name-for-the-legacy-print-client.md
Updated: 2026-05-07
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Find the computer name required by an existing legacy Print Client setup.
Use this article only when maintaining the standalone legacy Print Client. New setups should use the current Desktop App, which identifies its available machine in Starshipit's printing settings. See [Understand how Starshipit printing works](/articles/90200000000155-understand-how-starshipit-printing-works).
## Mac
1. Click the Apple Menu, located in the upper left-hand corner of the screen.
2. Select **System Preferences**.
3. Click **Sharing**.
4. **Computer Name** should be located at the top of the **Sharing**window.
## Windows 10/11
1. Click the **Start** menu. After that, you have two options:
* Use the search box.
1. Type **computer name** in the searchbox.
2. Select **View your PC name** in the results.
* Use the **Settings**window.
1. Click the **Settings**button.
2. Click the **System**category in the **Settings**window.
3. Click **About**in the menu on the left
+ You may need to scroll down to find the **About** menu by hovering your mouse pointer over the visible menu options.
2. Find your computer name to the right of the **Device name** row below **Device Specifications**
## Windows 8
1. Navigate to **PC Info** to find your computer name.
* Use the **Search** charm.
1. Move cursor to the right-hand corner of the screen to unhide charms bar (or press **Windows key** + **C**).
2. Click **Search**.
3. Type **computer name**.
4. Click **PC info**.
* Use the **Settings** charm.
1. Move cursor to the right-hand corner of the screen to unhide charms bar (or press **Windows key** + **C**).
2. Click **Settings**.
3. Click **PC info** under **Settings**, or click **Change PC settings**, at the bottom right of the **Settings** charm menu.
2. Find your computer name under **Computer name, domain, and workgroup settings**.
## Windows 7
1. Click the **Start**menu button.
2. Right-click on **Computer**.
3. Select **Properties**.
4. Find your computer name listed under **Computer name, domain, and workgroup settings**.
---
# (Legacy) Set up the print client
URL: https://support.starshipit.com/articles/115003720583-legacy-set-up-the-print-client
Canonical: https://support.starshipit.com/articles/115003720583-legacy-set-up-the-print-client
Markdown: https://support.starshipit.com/articles/115003720583-legacy-set-up-the-print-client.md
Updated: 2026-06-30
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Step-by-step guide to setting up (legacy) the print client.
:::warning
The Starshipit Desktop App now supports Print Client mode and replaces the standalone Print Client for supported setups. Follow the [Print Client mode setup in the Desktop App](/articles/printing-labels-packing-slips/printing/set-up-desktop-print-application) instead.
The steps below apply only to older setups that cannot use the Desktop App.
:::
## 1. Download and install the Print Client
1. In your Starshipit account, select **Settings > Printing > Advanced**.
2. Select **Add new print settings** or **Settings** under a label type.
3. Now click **Download Print Client for Windows** or **Mac**.
1. For Windows: To install the setup file, follow the steps in the installation wizard.
2. For Mac: Drag and drop the **Print Client** icon to the Applications Folder.
## 2. Connect the Print Client
1. Run the **Print Client** application on your computer.
2. Copy and paste the authorisation code from the page where you selected **Add new print settings** and selected your carrier name to create a Label Type in the very first step.
3. Paste your authorisation code in the **Print Client** application.
4. Select the printer.
5. Open the **Print Client** from the system menu bar.
1. For Mac users: You can find this in top right of your screen.
2. For Windows users: It is in the system tray in the bottom right of your screen.
Make sure the connection is successful by checking the green **Online** status in the Print Client.
## 3. Assign a label type to the Print Client
Assign a label type (in this example the "Packing Slip") to the computer where the Print Client is installed.
1. Go to **Settings**, select **Printing**, then select the **Advanced** tab.
2. Click **Add new print settings**.
3. Select the label type (e.g. Packing Slip).
4. Select the **Format**, and set **Print Client** as the **Print Method**.
5. Select the **Machine** that the Print Client is set to.
6. Click **Save**.
## 4. Assign a printer to the Print Client
1. Open the **Print Client** on your computer.
2. Go to the **Printers** Tab.
3. In the **Label Type**, select **Packing Slip**.
4. Select the **Printer Name** to print the Packing Slip e.g. Brother MFC-9140CDN.
5. Click **Assign**.
## 5. Check paper size and orientation
Check if the page parameter corresponds to the printer and the page loaded in the printer.
1. Click on the **Label Type** and **Printer Name**.
2. Check the Paper Size e.g. A4 for Packing Slip, and page orientation.
3. Click **Save Settings**.
---
# Connect a printer to your computer for Starshipit
URL: https://support.starshipit.com/articles/9171767654799-connect-a-printer-to-your-computer-for-starshipit
Canonical: https://support.starshipit.com/articles/9171767654799-connect-a-printer-to-your-computer-for-starshipit
Markdown: https://support.starshipit.com/articles/9171767654799-connect-a-printer-to-your-computer-for-starshipit.md
Updated: 2026-02-26
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Step-by-step guide to setting up your printer with Starshipit on Windows and macOS.
Connect a physical printer to Windows or macOS before selecting it in the Starshipit Desktop App.
This article covers the operating-system step only. To configure Starshipit's routing and local printer mappings, follow [Understand how Starshipit printing works](/articles/90200000000155-understand-how-starshipit-printing-works).
## Before you begin
- Admin access to your computer
- A connected printer (wired or wireless)
#### 1. Connect your printer
##### Wired printers
- If your printer uses a cable, connect it to your computer.
- Wait for Windows to install the required driver.
##### Wireless printers
1. Select **Start** > **Settings** > **Bluetooth & devices** > **Printers & scanners**.
2. Next to **Add a printer or scanner**, select **Add device**.
3. Wait for it to find nearby printers, then locate the one you want to use and select **Add device**.
Read more about adding a printer or scanner in Windows [here](https://support.microsoft.com/en-us/windows/add-a-printer-or-scanner-in-windows-14d9a442-0bcb-e11c-7a6c-63f00efae79f).
After this step, your printer is available to the operating system.
#### 2. Confirm the paper and driver settings
Open the printer's preferences in **Printers & scanners** and confirm its paper size and orientation match the labels you will use.
If a label is offset, you may need to adjust the Windows printer settings:
1. Go to **Printers & scanners** settings.
2. Find your label printer and click **Manage**.
3. Add spacing to the unprintable area – you may need to test print a few times to get the spacing right.
Print a Windows test page or manufacturer test label before you continue. This confirms the printer works outside Starshipit.
#### 1. Connect your printer
##### Wired printers
- Connect the USB cable to your Mac.
- If prompted, install the printer software.
##### Wireless printers
- If needed, connect the printer to your Mac with USB for first-time setup.
- Install the printer software and follow the setup assistant to connect to your network.
- Disconnect the cable once setup is complete.
##### Add the printer to your list of available printers
1. Choose Apple menu > **System Settings**.
2. Click **Printers & Scanners** in the sidebar.
3. If you don't see your printer listed, click the **Add Printer, Scanner or Fax** button. A pop-up will appear listing the printers on your local network.
4. When your printer appears in the list, select it, then click **Add**. You may then need to download additional software for the printer to work.
Read Apple's guide on adding a printer to your printer list [here](https://support.apple.com/en-nz/guide/mac-help/mh14004/mac).
After this step, your printer is available to macOS.
#### 2. Confirm the paper and driver settings
In **Printers & Scanners**, open the printer's options and confirm its paper size and orientation match the labels you will use.
Print a macOS test page or manufacturer test label before you continue. This confirms the printer works outside Starshipit.
## Verify the printer before configuring Starshipit
Before you set up Starshipit printing, make sure the printer appears in your computer's printer list and can print a test page or manufacturer test label. If it cannot, resolve the computer or printer issue first; Starshipit cannot select a printer that the operating system cannot use.
## Set up Starshipit printing
[Set up and test Starshipit printing](/articles/90200000000155-understand-how-starshipit-printing-works). If you use automatic printing, you must configure both the Starshipit account's machine route and the Desktop App's local physical-printer mapping.
---
# Choose a shipping label printer and label size
URL: https://support.starshipit.com/articles/360001921655-choose-a-shipping-label-printer-and-label-size
Canonical: https://support.starshipit.com/articles/360001921655-choose-a-shipping-label-printer-and-label-size
Markdown: https://support.starshipit.com/articles/360001921655-choose-a-shipping-label-printer-and-label-size.md
Updated: 2026-05-07
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Choose a compatible shipping label printer and the label size required by your couriers.
## Choose a printer
Starshipit can use a printer that is installed and working in your computer's operating system. Choose a current model that:
* supports the label sizes required by your couriers
* has a current driver for your Windows or macOS version
* supports your preferred USB or network connection
* is supported by its manufacturer in your region
Most shipping labels use 100 x 150 mm (approximately 4 x 6 inch) stock, so a four-inch label printer is a practical starting point. Some couriers and documents require a different size; check the table below before buying hardware.
Direct thermal and thermal transfer printers can both be suitable. Direct thermal printers use heat-sensitive labels and do not need a ribbon. Thermal transfer printers use a ribbon and are useful when labels must remain readable for longer or tolerate harsher conditions. Match the printer technology to the correct label stock.
Starshipit does not require a specific printer brand or model. Before purchasing, confirm compatibility with the printer manufacturer and test the required courier formats where possible.
After connecting the printer, [set up and test the Starshipit printing route](/articles/90200000000155-understand-how-starshipit-printing-works).
## Label sizes
The exact formats available depend on the courier, product, destination, and account configuration. The format options shown in the relevant courier settings are the source of truth for your account.
Common output sizes include:
| Format | Typical use |
| --- | --- |
| **100 x 150 mm (A6 / approximately 4 x 6 inch)** | Standard thermal shipping labels for many domestic and international services. |
| **100 x 174 mm or 100 x 175 mm** | Longer shipping labels used by some services. |
| **100 x 200 mm** | Extended shipping labels used by some services. |
| **A4** | Courier documents, commercial invoices, international labels, or multi-label sheets. |
Some formats have workflow restrictions. For example:
* [Australia Post A4 label sheets](/articles/360000313576-how-to-print-australia-post-shipping-labels-4-per-page) must be downloaded and printed as a PDF.
* [Australia Post eParcel A6 CN22 labels](/articles/360001225675-australia-post-eparcel-a6-cn22-labels) are available only when the shipment meets Australia Post's criteria.
* A courier may produce extra documents, such as commercial invoices, on A4 even when the shipping label uses thermal stock.
Check every courier service your team uses, including domestic, international, returns, and dangerous-goods workflows, before standardising a packing station on one printer or label size.
---
# Set authority to leave or require a signature
URL: https://support.starshipit.com/articles/90200000000403-set-authority-to-leave-or-require-a-signature
Canonical: https://support.starshipit.com/articles/90200000000403-set-authority-to-leave-or-require-a-signature
Markdown: https://support.starshipit.com/articles/90200000000403-set-authority-to-leave-or-require-a-signature.md
Updated: 2026-09-12
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Choose and automate authority-to-leave or signature-required delivery options for supported courier services.
Choose whether a supported courier can leave a parcel without a signature or must collect a signature on delivery.
## Before you begin
- Check that your courier and service support the delivery option you want to use.
- Confirm the courier's requirements before applying the option to your shipments. Availability, behaviour and price can vary by courier and service.
## Choose the right delivery option
- **Authority to leave (ATL)** allows a courier to leave the parcel in a safe place when the recipient is unavailable.
- **Signature required** asks the courier to collect a signature when the parcel is delivered.
## Set a default for a courier
Some courier integrations let you set a default delivery option in their advanced settings:
1. Go to **Settings > Couriers**.
2. Open the settings for your courier.
3. Select **Advanced**.
4. Enable the supported authority-to-leave, safe-drop, or signature-required option.
5. Select **Save**.
The available setting and its name vary by courier. Review the courier's setup guide if the option does not appear.
## Apply a delivery option with a rule
Use a rule when the option should apply only to matching orders, such as high-value orders:
1. Go to **Settings > Rules**.
2. Select **Add a new rule**.
3. Add the conditions that identify the orders.
4. Add **Set Authority To Leave** or **Set Signature Required** as the action, then set it to `True`.
5. Select **Save**.
To apply the rule to orders already in **New**, select **Run rules now**.
## Verify the delivery option
Before printing, open a matching order and check that the expected delivery option has been applied. Confirm the final service and price before you print the label.
## Check carrier-specific behavior
- [Configure delivery options for Australia Post](/articles/115000425263-configure-delivery-options-for-australia-post)
- [Create a rule based on order value](/articles/115000246946-rules-based-on-order-value)
- [Add authority-to-leave and signature-required options to Shopify checkout](/articles/360000085216-add-authority-to-leave-and-signature-required-options-to-your-shopify-checkout)
:::important
Delivery options can affect the quoted rate and whether the courier accepts the shipment.
:::
---
# Configure freight and shipping charges
URL: https://support.starshipit.com/articles/360004253016-configure-freight-and-shipping-charges
Canonical: https://support.starshipit.com/articles/360004253016-configure-freight-and-shipping-charges
Markdown: https://support.starshipit.com/articles/360004253016-configure-freight-and-shipping-charges.md
Updated: 2026-07-20
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Configure how Starshipit submits freight and shipping charges on customs declarations and commercial invoices.
Configure how Starshipit submits freight or shipping costs with shipments that require customs declarations or commercial invoices. This is an account-wide setting rather than a setting for one courier.
## Choose how shipping charges are submitted
Starshipit provides four options under **Freight/shipping charges**:
- **Do not submit shipping cost**: Do not include a shipping charge.
- **Submit imported shipping charges from your platform**: Use the shipping amount imported with the order.
- **Submit a flat rate**: Submit the same shipping amount for every applicable shipment.
- **Submit the actual cost of shipping**: Submit the shipping rate returned for the shipment.
The imported option requires your sales channel or order source to send the shipping amount to Starshipit.
## Configure freight and shipping charges
1. Go to **Settings > Options**.
2. Find **Freight/shipping charges**.
3. Select how Starshipit should submit shipping costs.
4. If you selected **Submit a flat rate**, enter the amount to submit.
5. Click **Save**.
## Configure the order value adjustment
If the imported order total includes tax, duties, or shipping, configure an order value adjustment so the declared item values match the amount paid by the customer.
1. Go to **Settings > Integrations**.
2. Find **Order value adjustment**.
3. Select the adjustment method that matches the values imported from your sales channel.
4. Click **Save**.
:::important
Choose an adjustment method that matches the data supplied by your sales channel. Applying the wrong adjustment can make the declared item total differ from the customer’s order total.
:::
## Verify the shipping charge
Create or import a test international order, then generate its customs documents using your usual courier service. Check that the shipping charge and declared item total on the commercial invoice match the option you selected.
---
# Insurance cover and warranty
URL: https://support.starshipit.com/articles/6708771320463-insurance-cover-and-warranty
Canonical: https://support.starshipit.com/articles/6708771320463-insurance-cover-and-warranty
Markdown: https://support.starshipit.com/articles/6708771320463-insurance-cover-and-warranty.md
Updated: 2026-05-06
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Understand shipment insurance options and warranty cover in Starshipit.
You can apply insurance to your shipments so that if something happens to your package, you will be reimbursed up to the value you’ve applied.
Here are the supported carriers in Starshipit:
* Australia Post eParcel (Cover/Warranty)
* Australia Post MyPost Business (Cover/Warranty)
* StarTrack (Cover/Warranty)
* DHL Express (Shipment Value Protection)
* TNT (Extended Warranty)
* Team Global Express IPEC/Priority (Extra Service)
Please note that different carriers may refer to 'insurance' by different names.
## How it works
Getting insurance applied to a shipment requires two things:
1. Checking the cover/warranty checkbox on the order.
2. Specifying the cover amount.
You can do this manually or using a rule. You must supply a cover amount. If you don’t, the shipment will be insured for $0 (meaning you won’t be able to claim it).
## Creating the rule
Here’s how you set up the rule in Starshipit:
1. In Starshipit, navigate to **Settings** > **Rules**.
2. Select **Add a new rule**.
3. Under Condition(s) select what is relevant for you.
4. Under Action, select **Set Insurance Required** = True
5. Click **Save**.
For example, you may wish to apply insurance to everything over a certain amount.
This will both tick the cover/warranty box and set the default insurance value to match the declared value (I.e. if your order was $100, $100 worth of cover will be applied).
## Insurance pricing structure
Typically, you’ll have a defined cover rate as part of your contract with your courier. For example, you may agree that your cover rate is 1%, which means if you insure a package for $250, then you’ll pay $2.50 in “insurance”.
It’s best to discuss this with your courier account manager, however, as it works a bit differently for different courier companies.
## How to make an insurance claim
If you’ve insured your package and something happens to the package, you can go directly to your courier and lodge an insurance claim. The courier will then pay out the amount you declared as the cover value.
## Carrier specific things to note
* MyPost business offers free cover up to $100 but charges for every dollar over $100. If you’d like to prevent your account from ever declaring over this amount you can enable an option from your settings. You can learn more about this [here](https://starshipit.canny.io/changelog/mypost-business-option-to-limit-extra-cover).
* TNT has different types of warranty. Before using it, you will need to select which type you would like to apply to your shipments from Settings > Couriers > TNT > Advanced. You can learn more about this [here](https://starshipit.canny.io/changelog/tnt-support-for-extended-warranty-insurance).
* Sometimes, couriers will have specific requirements before you can insure your package. For example, if you wish to insure your package for a large value, the courier may require that the package is “Signature required” to lessen the risk of something happening to the order. You should confirm the specific requirements with your courier account manager.
---
# Dangerous goods in Starshipit
URL: https://support.starshipit.com/articles/9865634439183-dangerous-goods-in-starshipit
Canonical: https://support.starshipit.com/articles/9865634439183-dangerous-goods-in-starshipit
Markdown: https://support.starshipit.com/articles/9865634439183-dangerous-goods-in-starshipit.md
Updated: 2026-05-06
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Learn how to ship dangerous goods with Starshipit using supported carriers like Australia Post, DHL Express, UPS, and more.
* You can use Starshipit to manage shipping dangerous goods with certain carriers.
* Dangerous goods are substances that are hazardous, meaning they have properties which could pose a risk to people, property or the environment. Common items like perfume and electronic equipment can be classed as dangerous goods, due to the chemicals and products they contain. This means there are tight controls over transporting dangerous goods.
* Read [our blog](https://starshipit.com/blog-content/transporting-dangerous-goods-australia#how-do-you-ship-dangerous-goods-safely) to learn the different types of dangerous goods, how the Australian classification system works and how you can ship dangerous goods safely within Australia.
## How it works
Starshipit supports sending dangerous goods with the following carriers. To start shipping dangerous goods using these carriers, check out the guides linked below:
* [Australia Post eParcel](#h_01HZ189BFZ20K31K07YET7JKV4)
* [Border Express](/articles/couriers/border-express/border-express-dangerous-goods)
* [CouriersPlease](/articles/couriers/couriersplease/couriersplease-dangerous-goods)
* [DHL Express](/articles/couriers/dhl/dhl-express-dangerous-goods)
* [NZ Post Domestic](#01HZ66C6SYPEDVJM2DSA0NG3JQ)
* [Post Haste](/articles/couriers/post-haste/sending-dangerous-goods-with-post-haste)
* [NZ Couriers](/articles/couriers/nz-couriers/sending-dangerous-goods-with-nz-couriers)
* [StarTrack](/articles/couriers/startrack/startrack-dangerous-goods)
* [TnT](/articles/couriers/tnt/tnt-dangerous-goods)
* [UPS](/articles/couriers/ups/ups-dangerous-goods)
#### Dangerous goods with Australia Post
Starshipit supports sending dangerous goods with eParcel Parcel post. We do not support Express Post. This is due to a rule from Australia Post, as there are tight restrictions around transporting dangerous goods.
#### Dangerous goods with NZ Post Domestic
Starshipit supports sending dangerous goods with NZ Post Domestic. You will first need to obtain approval from NZ Post by contacting your NZ Post account manager. Once approved, you will then be able to flag a shipment as dangerous goods in the order details page.
## Create rules for dangerous goods
You can create a variety of different rules to create a dangerous goods shipping process that works for you. For example, you might want to add a tag to flag orders containing dangerous goods to your warehouse staff.
#### Classify orders containing dangerous goods
1. In Starshipit, navigate to **Settings** > **Rules**.
2. Click **Add a new rule**.
3. Click **Condition(s)** > **Item SKU** > (Enter the SKUs of your dangerous goods items).
4. Select **Action** > **Set dangerous goods type** Or Select **Action** > **Set Contain Battery**.
5. Click **Save**.
#### Remove unsupported couriers at checkout
Some couriers won’t transport dangerous goods (for example flammable items or products that include batteries). Using Starshipit, you can create a rule to remove these couriers from the checkout if the cart contains a dangerous item.
1. In Starshipit, navigate to **Settings** > **Rules**.
2. Click **Add a new rule**.
3. Click **Condition(s)** > **Item SKU** > (Enter the SKUs of your dangerous goods items).
4. Select **Action** > **Set Carriers** **for Checkout**.
5. Select the couriers you’d like to display in your checkout.
6. Click **Save**.
---
# Alcohol delivery with Starshipit
URL: https://support.starshipit.com/articles/10774595330959-alcohol-delivery-with-starshipit
Canonical: https://support.starshipit.com/articles/10774595330959-alcohol-delivery-with-starshipit
Markdown: https://support.starshipit.com/articles/10774595330959-alcohol-delivery-with-starshipit.md
Updated: 2026-05-06
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Learn how to ship alcohol with Starshipit, including age verification settings and carrier-specific options for Startrack, Australia Post, Sherpa, Rendr, Uber, and NZ Post.
When shipping alcohol, to comply with regulations you often need to specify that your shipments contain alcohol/are age-restricted so that courier drivers will check the customer's ID. Not all couriers support shipping alcohol so if you're ever unsure, we recommend speaking directly with your courier account manager to confirm this.
## Packaging requirements
Many couriers will have specific requirements for how you must package your order to ensure the safe delivery of your product. Some requirements typically include:
* Ensuring there is separation between the bottles in the package
* Ensuring bottles are facing upright
* Including a sticker/indicator that the package contains alcohol
Please refer to your courier as they will be able to provide you a full list of requirements.
## Carriers that support alcohol delivery with Starshipit
### Startrack on Demand
#### ID Check with TONID Service
1. Navigate to **Settings** > **Couriers** > **Startrack Settings** > **Advanced** tab > Ensure **Call the API directly** is ticked to avoid using legacy settings.
2. Add **TONID** to your product codes.
3. Select the desired behaviour from the delivery types drop-down.
* Typically, ID25 no ATL (Alcohol Delivery) is used, meaning anyone looking younger than 25 must show ID, and the package cannot be left in a safe place.
4. When you ship orders with TONID, these settings apply automatically.
### Australia Post
#### Specific wine/alcohol services
Speak to eParcel about loading specific alcohol service codes onto your account such as:
* 3O85
* 3P85
* 3V85
* 7O35
* 7O85
When processing orders with these codes, Starshipit will flag them as containing alcohol, prompting the courier driver to verify the recipient's ID upon delivery. These options combine with signature required/safe drop settings, allowing customers to opt for packages to be left in a safe place.
No additional setup will be required from your end. Simply print the order with the service code, and the rest is handled automatically.
Australia Post has a wine guide available [here](https://auspost.com.au/content/dam/auspost_corp/media/documents/australia-post-wine-guide.pdf) if you'd like to learn more.
### Sherpa
#### Alcohol (18+) delivery option
* Tick **Alcohol (18+)** on each order to ensure ID is checked.
* Alternatively, set **Alcohol (18+)** as the default for Sherpa shipments. You can do this by:
+ Navigating to **Settings** > **Couriers** > **Sherpa Settings** > **Advanced** tab and ticking the **Alcohol (18+)** box.
### Rendr
#### Alcohol (18+) delivery option
* Tick **Age Restricted** on each order to ensure ID is checked.
* Alternatively, set **Alcohol (18+)** as the default for Rendr shipments. You can do this by:
+ Navigating to **Settings** > **Couriers** > **Rendr Settings** > **Advanced** tab and ticking the **Alcohol (18+)** box.
### Uber
#### Age Restricted delivery option
* Tick **Age Restricted** on each order to ensure ID is checked.
* Alternatively, set **Age Restricted (default)** as the default for Uber shipments. You can do this by:
+ Navigating to **Settings** > **Couriers** > **Uber Settings** > Scroll down to **Delivery Options** and tick the **Age Restricted (default)** box. You can also specify the minimum age requirement.
### NZ Post
Please reach out to NZ Post and request that the following services are added to your account:
* CPOL18R
* CPOL18RA
Once added, you'll see an **Age Restricted** option on your NZ Post orders in Starshipit.
* Tick **Age Restricted** on each order to ensure ID is checked.
* Alternatively, set **Age Restricted (default)** as the default for NZ Post shipments. You can do this by:
+ Navigating to **Settings** > **Couriers** > **NZ Post Settings** > **Advanced** tab and tick the **Age Restricted (default)** box.
#### Requirements
NZ Post have the below requirements for your shipments:
* All cartons must have a board weight equivalent of B Flute.
* All cartons must include arrow up and fragile stickers/printed labels on all sides of the carton.
* All alcohol shipped must have corrugated dividers in between the bottles (to prevent label and product damage).
## Best practice for alcohol deliveries with Starshipit
#### Setting up rules in Starshipit
You can create rules on checkout to only show certain courier options when alcohol products are in the cart. For example, if an item SKU contains **R18**, set the carrier for checkout to Australia Post.
#### Customer notifications
Notify customers that they will need to show ID for their alcohol deliveries. Consider including this information in your email notifications.
Turn on the **Out for Delivery** notification so customers can be prepared to sign for their order. You can set this by:
* Navigating to **Settings** > **Tracking and notifications** > Scroll down to **Configure your customer notifications** > Tick the box in the **Out For Delivery** row.
---
# Import orders
URL: https://support.starshipit.com/articles/206705193-import-orders
Canonical: https://support.starshipit.com/articles/206705193-import-orders
Markdown: https://support.starshipit.com/articles/206705193-import-orders.md
Updated: 2026-05-07
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Learn how to import orders automatically or manually into Starshipit.
You can choose to import orders automatically or manually. Starshipit recommends you import orders automatically to prevent orders from being missed.
{{video:youtube:tReUF9Whu2U}}
## Automatically import orders
1. In your Starshipit account, go to **Settings** \> **Integrations**.
2. Select **Automatically import orders from all integrations (typically every 20 minutes)**.
3. Click **Save**.
## Manually import orders
1. In your Starshipit account, select **Orders**.
2. Click **Import**, then select:
* **Import Orders** \- Select the integration that you want to import from\, and the number of days you want to import the orders from\.
* **Upload** \- Select and [import a CSV file](/articles/integrations/csv/csv-file-integration).
## Set the status to import
When you set up your integration, you can set the status of orders to be imported. The default status is **open**. To change your importing status:
1. Go to **Settings** \> **Integrations**.
2. Select your integration e.g. Shopify.
3. Set the **Status to import**.
Once imported, the system will show you how many orders it has brought over. The imported orders are now visible in the **New** tab on the **Orders** page.
---
# Create a manual order
URL: https://support.starshipit.com/articles/206358586-create-a-manual-order
Canonical: https://support.starshipit.com/articles/206358586-create-a-manual-order
Markdown: https://support.starshipit.com/articles/206358586-create-a-manual-order.md
Updated: 2026-05-07
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Learn how to add manual orders into your order queue in Starshipit.
Starshipit makes it easy to add manual orders into your order queue, which is useful for retailers that operate across multiple channels.
{{video:youtube:kvBm0NGgGGE}}
## Create a manual order
1. In [Starshipit](https://app.starshipit.com/), navigate to **Orders**.
2. Click **Create Order** on the top right of the dashboard.
3. Enter the contact and address details, then click **Next**.
4. Add new items, and edit item details as required.
5. Edit your packaging type.
6. Select your courier service.
7. Choose your delivery options.
8. Click **Save Order** or **Print Labels**.
1. In [Starshipit](https://app2.starshipit.com/), navigate to **Orders**.
2. Click **Create Order** on the top right of the dashboard.
3. Enter the contact and address details, then click **Save**.
4. Add new items, and edit item details as required.
5. Edit your packaging type.
6. Select your courier service.
7. Choose your delivery options.
8. Click **Save** or **Print**.
---
# Remove and re-import orders
URL: https://support.starshipit.com/articles/360000118196-remove-and-re-import-orders
Canonical: https://support.starshipit.com/articles/360000118196-remove-and-re-import-orders
Markdown: https://support.starshipit.com/articles/360000118196-remove-and-re-import-orders.md
Updated: 2026-05-07
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Remove and re-import orders from your eCommerce platform.
There are various situations where you might need to remove and then re-import orders. For instance, if you've established new business rules to streamline courier assignments, removing and re-importing orders can ensure these rules are correctly applied.
:::note
It's important to note that orders which have been saved/edited will not be removed when you select Remove all unshipped orders. This is because the changes will not be retained when you remove the order. If you would still like to remove these, you can manually select them all and select Delete. Please watch out for the saved order icon.
:::
#### Step 1: Remove Imported Unshipped Orders
* Go to the **Orders**section
+ Classic UI: Click **Actions > Remove Imported Unshipped Orders.** 
+ UI 2.0: Click the **Import Orders drop down** > Select **Delete all imported unshipped orders** > Confirm the action by selecting **delete.**
#### Step 2: Re-import Your Orders
Once the removal process is complete, you can proceed to re-importing the orders:
1. **Classic UI:**
* Click **Import** and choose from the available options: **Import All**, **Import Option**, or **Import CSV**.**UI 2.0:**
* Click **Import Orders**, then select either **Integration** or **CSV**.
2. In the pop-up window, choose the integrations from which you want to import orders, and specify the time frame of the orders.
3. Click **Import**.
4. Your orders will be re-imported, incorporating any changes made or actions applied by your rules.
For more detailed information on importing orders, please refer to [this article](/articles/orders-manifests-reports/orders/import-orders).
---
# Process an order from import to manifest
URL: https://support.starshipit.com/articles/115000487123-process-an-order-from-import-to-manifest
Canonical: https://support.starshipit.com/articles/115000487123-process-an-order-from-import-to-manifest
Markdown: https://support.starshipit.com/articles/115000487123-process-an-order-from-import-to-manifest.md
Updated: 2026-07-20
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Follow the complete Starshipit workflow from bringing in an order through checking, printing, and manifesting it.
Follow the complete Starshipit shipping workflow to bring in an order, check its details, select a courier service, print its label, and manifest it for handover.
## Before you begin
Make sure you have:
- Set your pickup address.
- [Connected a courier](/categories/couriers).
- [Connected your sales channel or business system](/categories/integrations), or prepared another way to bring orders into Starshipit.
- [Choose and test your printing route](/articles/90200000000155-understand-how-starshipit-printing-works). The Desktop App is required for automatic routed printing, but not for PDF downloads or supported direct-device printing.
## 1. Bring in the order
Orders can import automatically from a connected system, or you can import them manually.
1. Open **Orders**.
2. Click **Import**.
3. Select **Import Orders** to import from an integration, or **Upload** to import a CSV file.
4. Select the integration and date range when prompted.
5. Confirm the imported order appears under **New**.
1. Open **Orders**.
2. Open **Import orders**.
3. Select **From integration** or **From CSV**.
4. Complete the import options, then confirm the import.
5. Confirm the imported order appears under **New**.
For automatic-import settings and detailed options, see [Import orders](/articles/206705193-import-orders).
## 2. Check the order
Review the receiver address, items, package, weight, and delivery instructions before purchasing a label.
1. Enable **Invalid only** to find orders with invalid addresses.
2. Click **Auto Correct** and review the suggested changes.
3. Click **Save** when the address is correct.
4. Open the order to review its items, package, weight, and instructions.
1. Open **More actions**, then select **Check addresses**.
2. Select the invalid orders you want to correct.
3. Click **Update** and review the suggested changes.
4. Open the order to review its items, package, weight, and instructions.
See [Validate shipping addresses](/articles/215482503-validate-shipping-addresses) when an address needs individual correction.
## 3. Choose a service and print the label
1. Open the order from **Orders > New**.
2. Review the package weight and dimensions.
3. Select the courier and service.
4. Review the quoted cost where available.
5. Click **Print Labels**.
1. Open the order from **Orders > New**.
2. Review the package weight and dimensions.
3. Under **Carrier and product**, select the courier service you want to use.
4. Review the quoted cost where available.
5. Save any changes, then use the print action to generate the shipping label.
Printing creates the tracking number and moves the order to **Printed**. See [Get a carrier quote](/articles/8306039132943-get-a-carrier-quote) when you need to compare options first.
## 4. Manifest the shipment
Not every courier requires a manifest. Check [Manifesting FAQs](/articles/360001997955-manifesting-faqs) if you are unsure.
1. Open **Orders > Printed**.
2. Select the orders you are handing over.
3. Click **Manifest**, then confirm the dispatch.
4. Download the manifest report if your driver or drop-off point requires it.
1. Open **Orders > Printed**.
2. Select the orders you are handing over.
3. Open the bulk actions and select **Manifest orders**, or click **Manifest all**.
4. Confirm the manifest.
5. Download the manifest report if your driver or drop-off point requires it.
The shipment is ready for courier pickup or drop-off when the required manifest has been successfully submitted.
---
# Find an order
URL: https://support.starshipit.com/articles/9129132440847-find-an-order
Canonical: https://support.starshipit.com/articles/9129132440847-find-an-order
Markdown: https://support.starshipit.com/articles/9129132440847-find-an-order.md
Updated: 2026-09-14
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Find an order in Starshipit using its order or tracking number, or customer details.
Find an order from the **Search**, **Orders**, or **Workflows** page using its order number, tracking number, or customer details.
## Choose a search route
### Search from the Search page
1. Go to [Starshipit](https://app.starshipit.com/).
2. Go to the **Search** page.
3. Enter the order number in the search bar.
### Search from the Orders page
1. Go to the **Orders** page.
2. Click the search bar.
3. Search using one of the following:
* Order number
* Tracking number
* Customer email
* Customer name
### Search from Workflows
1. Go to the **Workflows** page.
2. Select **Search for an order**.
3. Search using any of the fields mentioned above.
:::tip
You can also click the tick box **Include orders from child accounts** to search for orders across your child accounts.
:::
### Search from the Search page
1. Go to [Starshipit](https://app.starshipit.com/).
2. Go to the **Search** page.
3. Enter the order number in the search bar.
### Search from the Orders page
1. Go to the **Orders** page.
2. Click the search bar.
3. Search using one of the following:
* Order number
* Tracking number
* Customer email
* Customer name
## Check that you found the right order
Open the result and compare its order number or tracking number with your records before you make changes or print a label.
---
# Update an order
URL: https://support.starshipit.com/articles/206705203-update-an-order
Canonical: https://support.starshipit.com/articles/206705203-update-an-order
Markdown: https://support.starshipit.com/articles/206705203-update-an-order.md
Updated: 2026-05-07
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Update an order's address, item, package, and courier details.
You can update an order's address, item, package and courier details.
## Batch update
If you would like to update the shipping service you are using for some orders in the new tab in bulk please follow the below steps:
1. Select all the orders that should be updated.
2. Click on **Batch update** in the top menu.
3. Tick Product checkbox and enter in the product code of the service you would like to use e.g WPX.
4. Select the carrier from the drop-down.
5. Click **Update**.
## Edit sender and receiver details
1. Open the order you'd like to edit from the **New** orders grid.
2. Click the pencil edit icon next to either the **Sender** or **Receiver** section.
3. Click **Save** in the bottom right of the dialog box to save your changes.
4. Once you've finished making all your changes, click **Save** in the bottom right of the order dialog.
## Edit items
1. Open the order you'd like to edit from the **New** orders grid.
2. Click the **Expand** arrow next to the **Items**section.
3. Click the pencil edit icon next to the item you'd like to edit.
4. Click **Update order** in the bottom right of the order dialog to save your changes.
5. Once you've finished making all your changes, click **Save** in the bottom right of the order dialog.
## Edit packages
1. Open the order you'd like to edit from the **New** orders grid.
2. Click the **Expand** arrow next to the **Packaging** section.
3. Edit the details of each package such as quantity, length, width, height and weight, or you can choose to **Add a new package**.
4. Once you've finished making all your changes, click **Save** in the bottom right of the order dialog.
## Edit courier
1. Open the order you'd like to edit from the **New** orders grid.
2. Scroll down to the **Courier** section.
3. Select the desired carrier service.
4. The options shown on the right will change based on the service selected.
5. Once you've finished making all your changes, click **Save** in the bottom right of the order dialog.
---
# Validate shipping addresses
URL: https://support.starshipit.com/articles/215482503-validate-shipping-addresses
Canonical: https://support.starshipit.com/articles/215482503-validate-shipping-addresses
Markdown: https://support.starshipit.com/articles/215482503-validate-shipping-addresses.md
Updated: 2026-05-07
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Learn how to automatically correct invalid shipping addresses so orders are delivered to the right place.
Starshipit lets you automatically correct invalid addresses, so even if a customer has input the wrong details, the order can be delivered to the right place. Invalid addresses are highlighted in the new orders screen by a red cross.
{{video:youtube:qeUdvcDhlx0}}
## How address validation works
* Address validation uses the Google Maps API to verify the full address string and minimise printing errors. If no results return from Google Maps API, the order is marked invalid.
* The address data is then sent to the courier API on a Print Labels action.
* Each courier applies its own validation rules (for example, suburb or city checks).
* If the courier rejects the address, the label will not be generated.
### Option 1: Auto-correct
1. Select the **Invalid only** switch on the top left of the Starshipit app, then click the auto correct button in the top right.
2. Each address that has an issue will be automatically checked, and if a solution is found it will be displayed with the modified address highlighted in red.
3. Ensure you check each change before saving the changes, using the **Save** button at the top of the app.
### Option 2: Screen inline editing
1. For any addresses that cannot be auto-corrected, edit the address directly from the invalid only screen (note: inline address editing will not work in the new orders screen).
2. Click on the field that you wish to edit, then edit. Once complete, save your changes using the **Save** button at the top.
:::warning
To avoid inadvertently changing state or suburb, it is important that you check the suggested corrections and don't just automatically select them.
:::
### Option 3: Edit address in the shipping dialog
The shipping dialog can be displayed at any time by clicking the order number or the name. In the shipping dialog there are several tools to fix any remaining issues:
1. The address auto-complete lookup
2. Suburb lookup
3. Link to Google Maps
### Option 1: Bulk auto-correct addresses
From the **Orders** screen, click **Check addresses** to filter the invalid orders.
Once you see a list of the invalid orders, select the orders you want to correct, and click **Update**.
### Option 2: Auto-correct individual addresses
To auto-correct an individual address:
1. Go to the **Orders** screen.
2. Click the pencil edit icon next to an order with an incorrect address in the **Customer** column.
3. In the Receiver address pop-up, you'll see the incorrect address displayed on the left, and the suggested correct address on the right.
4. Click **Apply suggestions** to update the address, then click **Save**.
### Option 3: Manually edit an address
To manually edit addresses:
1. Go to the **Orders** screen.
2. Identify the invalid address by the red exclamation mark symbol next to the customer's name.
3. Click the order number.
4. Click the pencil edit icon under **Receiver** to manually edit the address.
5. Click **Check address** to validate it.
6. Click **Confirm** to save your changes.
7. Click **Save** again.
---
# Use an Address Book contact on an order
URL: https://support.starshipit.com/articles/90200000000512-use-an-address-book-contact-on-an-order
Canonical: https://support.starshipit.com/articles/90200000000512-use-an-address-book-contact-on-an-order
Markdown: https://support.starshipit.com/articles/90200000000512-use-an-address-book-contact-on-an-order.md
Updated: 2026-07-20
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Find a saved Address Book contact, create an order from it, or save an order address for future use.
Use a saved Address Book contact to populate the receiver details on a live order without entering the address again.
## Find and use a contact
Search the Address Book using the contact's name or code.
- Select the contact's name or company to create a shipment using the saved details.
- Select **Edit** if you need to update the saved contact without creating an order.
- Select **Create order** beside a contact to create a manual order using the saved details.
- Open the contact's action menu and select **Edit** to update it without creating an order.
## Save an order address as a contact
Select **Save contact to Address Book** while entering an address on an order. If you selected an existing contact, Starshipit updates that contact when you save the changed address.
## Verify the order
Before printing, confirm the receiver name, address, delivery instructions, carrier, and signature preference match the shipment you are sending.
To create or import reusable contacts, see [Set up and manage your Address Book](/articles/90200000000404-set-up-and-manage-your-address-book).
---
# Use Starshipit Sidekick in Chrome
URL: https://support.starshipit.com/articles/9449880256015-use-starshipit-sidekick-in-chrome
Canonical: https://support.starshipit.com/articles/9449880256015-use-starshipit-sidekick-in-chrome
Markdown: https://support.starshipit.com/articles/9449880256015-use-starshipit-sidekick-in-chrome.md
Updated: 2026-07-17
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Access Starshipit order information and functionality in a Chrome side panel, including tracking status, the ability to print labels, look up rates and more.
:::note
Available for Cin7 Omni, Shopify, WooCommerce and Magento2. Sidekick can also be used outside of these integrations — for example, from any web application. In this case, you’ll just need to enter the order number manually, as Sidekick won’t be able to automatically detect it for you.
:::
## Use cases
* Bring up the Starshipit Sidekick panel from other applications (like Shopify and Cin7 Omni), meaning you never have to toggle screens to go looking for a tracking number again.
* Quickly access order information from Shopify, WooCommerce, Cin7, Magento2 and Cin7 Omni — or anywhere else you’re working, by manually entering the order number.
* Print labels, open orders in Starshipit and copy the tracking number directly from the side panel.
* Quote shipping without an order: Enter an address and package details to instantly view courier rates. This avoids having to create and then archive a dummy order, making it handy for quoting directly from wherever you’re working (e.g. from an email asking “how much to ship X?”).
{{video:youtube:hhTz5OdmuHg}}
## How to get started
1. Install the [extension](https://chromewebstore.google.com/detail/starshipit-sidekick/ipmmpndoihnngmebnhdemckddpdgeppj?hl=en-GB&authuser=0&pli=1) to your Chrome browser.
2. Right-click on the extension icon and go to **Options**, or open the extension and click the Settings cog. This will take you to the settings page for the extension.
3. You will need to enter your Starshipit API Key and Subscription Key. There is a link in the page that will lead you to the Starshipit API settings page. Copy these details across and save them in the extension settings page.
4. Enable the functionality for the platforms you use. For example, if you use Shopify to manage orders, toggle the **Shopify** setting. When you click **Save**, the extension will prompt you to allow it to access your data from shopify.com. Click **Allow** to ensure the extension works correctly.
5. You're now setup and ready to use the extension.
When you go to Shopify, and go to the order details page for a specific order, you should now see an **Open in Starshipit Sidekick** button. Clicking this will reveal information about the order in Sidekick in the side panel of your browser. From this side panel, you can print the order label, open the order in Starshipit and copy the tracking number.
## Look up rates
Use Sidekick to quickly view rates across all your connected couriers by entering the destination address and package details. This lets you:
* Quote shipping costs before an order is placed.
* Compare rates without creating an order in Starshipit.
* Provide instant quotes directly from wherever you’re working (like your inbox or another tool).
## Supported web browsers
You can use Starshipit Chrome extensions in either Google Chrome or Microsoft Edge. To install the extensions in Microsoft Edge, simply head to the Chrome Web Store (instead of the Edge Add-ons website).
---
# Get a carrier quote
URL: https://support.starshipit.com/articles/8306039132943-get-a-carrier-quote
Canonical: https://support.starshipit.com/articles/8306039132943-get-a-carrier-quote
Markdown: https://support.starshipit.com/articles/8306039132943-get-a-carrier-quote.md
Updated: 2026-05-06
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> View carrier quotes before printing a label and use them in your shipping decisions.
## How it works
### Directly from the orders grid:
1. In the **Orders** page, ensure you have the **Carrier & Product** column enabled. Click the **column selection cog** in the top right of the orders grid if you don't see this column.
2. You should now see the carrier product – as well as its quoted price – under the **Carrier & Product** column, for each order in the orders grid.
3. To edit the carrier and product selection, click the **edit icon** next to the price. This will bring up the **Edit carrier and product screen**, which lets you make changes.
### From the individual orders screen:
1. From the **Orders** page, click into an order.
2. Scroll down to the **Carrier** section.
3. In this section, you'll see a list of your integrated carriers, the available products and their rates.
4. Change the selected carrier product by selecting another one and clicking on it.
### From outside of Starshipit:
If you're integrating Starshipit with an external invoicing system, you may need to retrieve shipping quotes outside the Starshipit interface. To do this, you can utilize the [Starshipit API](/articles/integrations/the-starshipit-api/starshipit-api-overview) by following these steps:
1. Use the [Delivery Services API endpoint](/developers/api-reference/starshipit#endpoint-rates-post-api-deliveryservices-delivery-services) to submit the details of the order for which you need a shipping quote.
2. In the request body, make sure to set **include_pricing** to **true**. This will ensure that the response includes the pricing information for the order.
3. Review the returned prices to determine and select the most suitable courier option for your needs based on cost, delivery times, or any other criteria important to your business.
For additional information and specific API endpoints, please consult the [Starshipit API reference](/developers/api-reference/starshipit).
---
# Add and use order tags
URL: https://support.starshipit.com/articles/4929125101327-add-and-use-order-tags
Canonical: https://support.starshipit.com/articles/4929125101327-add-and-use-order-tags
Markdown: https://support.starshipit.com/articles/4929125101327-add-and-use-order-tags.md
Updated: 2026-05-07
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Learn how to use tags to add custom labels to your orders for easier identification and streamlined fulfilment.
Tags let you add custom labels to your orders, making it easier to identify important details at a glance in the orders grid and communicate instructions to your fulfilment team.
## Supported functionality
We've packed in a lot of functionality with tags. You can:
* Maintain a list of regularly used tags
* View tags in the new, printed and shipped orders grid
* Filter by tags
* Automate adding tags using the [rules engine](/articles/notifications-branded-tracking-rules-child-accounts/business-rules/rules-overview)
* Shopify only: Import tags from your eCommerce platform
* Shopify only: Perform actions based on the tags imported from Shopify
## Use cases
Some common use cases for tags are:
* **Preorder tags:** Tag all your orders that are a preorder so that they aren't accidentally dispatched by your team.
* **VIP:** Tag orders that are over a certain value threshold so that you can treat them as a VIP order.
* **Dispatch Dates:** Tag orders with a date that you want the order to be dispatched if the time the order is dispatched is important to your delivery model.
* **Can't fulfil:** If you are shipping from multiple locations, tag an order when you can't fulfil it and send it to another account.
* **Fraud:** If you have some locations or order values that you would like to double check, add a tag to these orders so you can see them quickly.
* **Sale:** If you had a promotion or sale, you may want to tag all orders from that sale so you can distinguish them from your other orders.
* **Local:** Tag orders that are close to your warehouse, you may want to send them with a local courier or deliver them yourself!
## What you need
Before getting started, you will need to enable the tags column on the orders grid.
1. On the **New** orders tab, click the settings cog in the top right.
2. Tick **Tags** > **Apply**.
Your tags will now display in the order grid on the right-hand side.
## Setting up tags
There are many different ways you can use tags with Starshipit.
### Tag list
Have tags you use all the time? Configure them ahead of time so your team has a predefined list to select from. You can find this from **Settings** > **Tags**. On this page, you will be able to add, delete and edit tags that are saved in your account.
### Assign tags
You can assign tags to orders as and when you need them.
When you open the order, below the **Items** section, you will see a section for tags where you can add or remove any tags.
You can assign tags to orders as and when you need them.
1. In the **Orders** grid, click the **Plus** in the tags column. From here you can add one (or multiple tags) and then click **apply**.
2. You can bulk assign tags from the orders grid by selecting all the orders you want to update, selecting **Add or Remove Tags** from the action menu, and then entering (or removing) the tags you'd like to apply.
3. You can also apply tags within individual orders. When you open the order, in the bottom right you will see a section for tags where you can add or remove any tags.
### Automate
You can also automate the addition of tags using our rules engine. Look for the new rule action **Assign Tags**. For more information on rules, see our [guide here](/articles/notifications-branded-tracking-rules-child-accounts/business-rules/rules-overview).
### Shopify integration
Shopify Enhanced users will find that Shopify tags automatically import when on a Starter Plus plan, and when the below setting is enabled in the **Advanced tab** of the Shopify settings page.
Shopify users can also use the new rule condition **Tags** to apply actions when certain tags are detected on import. Below is an example of configuring your account to only import orders when a certain tag is detected.
---
# Merge multiple orders into one order
URL: https://support.starshipit.com/articles/360000382295-merge-multiple-orders-into-one-order
Canonical: https://support.starshipit.com/articles/360000382295-merge-multiple-orders-into-one-order
Markdown: https://support.starshipit.com/articles/360000382295-merge-multiple-orders-into-one-order.md
Updated: 2026-05-07
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Merge multiple orders into one order for consolidated shipping.
:::warning
Once an order is merged you cannot unmerge the order from the parent or the parent order from the other orders. Once an order is merged into a parent order it cannot be reimported.
:::
#### 1. Select the orders you would like to merge
* Go to **Orders** > **New**.
* Select two or more orders you would like to merge.
#### 2. Select parent order and merge
* With the orders selected, click the **Actions** drop-down menu (in the top right of the orders grid) then **Merge Orders**.
* In the **Merge Orders** box, select the parent order from the drop-down menu then click **Merge**.
* Your orders will be merged into one order with the order reference number of the parent order.
#### 1. Select the orders you would like to merge
* Go to **Orders** > **New**.
* Select two or more orders you would like to merge.
* Select **Merge orders**.
#### 2. Select the main parent order to merge all other selected orders to
---
# Merge orders with Suggested Merges
URL: https://support.starshipit.com/articles/7954826200719-merge-orders-with-suggested-merges
Canonical: https://support.starshipit.com/articles/7954826200719-merge-orders-with-suggested-merges
Markdown: https://support.starshipit.com/articles/7954826200719-merge-orders-with-suggested-merges.md
Updated: 2026-05-07
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Use Suggested Merges to identify and combine orders with the same destination address.
**Merge Suggestions** displays our recommendations for orders you should combine because they share the same destination address. Merging is a smart way to consolidate shipments and cut costs.
Learn more about [merging orders.](/articles/orders-manifests-reports/faqs/how-to-merge-multiple-orders-into-one-order)
:::warning
Once an order is merged you cannot unmerge the order from the parent or the parent order from the other orders. Once an order is merged into a parent order it cannot be reimported.
:::
{{video:youtube:48QxwPkM6NQ}}
Learn how to merge orders and how to use our suggested merges feature.
## How it works
**Displaying Suggested Merges**
1. Sign in to your Starshipit account.
2. Ensure [you are on UI 2.0](/articles/getting-started/how-to-guides/switching-between-classic-ui-and-ui-2-0)
3. On the main order grid, select **SUGGESTED MERGES**. ****
4. Starshipit will reload the grid and display whether you have any orders that share a destination and therefore could be merged.
**Merging a single group**
1. Each alternating row color indicates orders belonging to the same suggested merge group.
2. To merge a group, tick the orders in the same row group.
3. Select **Merge** on the right-hand side.
4. In the pop-up dialog, **choose the parent order**.
5. Select **Merge**.
6. These orders are now combined and removed from the suggested merges group.
**Merging many merge suggestions in one go**
If you have multiple suggestions, you can bulk-merge orders.
1. Select all groups to merge or use the checkbox in the top left to select all orders.
2. Click **Merge All.**
(Note: When merging multiple orders at once, Starshipit will automatically select the oldest order as the parent.)
---
# Archive or remove orders
URL: https://support.starshipit.com/articles/360001763415-archive-or-remove-orders
Canonical: https://support.starshipit.com/articles/360001763415-archive-or-remove-orders
Markdown: https://support.starshipit.com/articles/360001763415-archive-or-remove-orders.md
Updated: 2026-05-07
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Learn how to archive, restore, and remove orders from Starshipit.
**Archive** and **Remove** have two distinct functions. Archiving is ideal if you've already printed an order but don't want to send it anymore, or if you have an unshipped order you want to keep in Starshipit until it's ready to go. Removing an order is used when you want to re-import it at a later date from your eCommerce platform. All order history is recorded, so you can see if an order was archived, redone, etc. along with a timestamp.
## How archiving works
* Archiving orders keep the orders in the Archived tab so they can still be accessed in Starshipit, but actions like reprint or manifest cannot be performed on them.
* If you want to perform actions on archived orders, they need to be restored first.
* Within the Archived tab, there are two sub-tabs: unshipped and shipped (any orders that had labels printed).
* You cannot remove printed and shipped orders from Starshipit however you can archive them.
* If you have previously archived an order, you can choose to restore it or completely remove it from Starshipit via the **Archived** tab.
:::note
If you redo an order, you are archiving that order and then making a clone of the same order. This is why you will have two copies of the same order: one that is archived and one that is not.
There is no mandatory waiting period between creating and archiving orders, however, it is recommended to archive orders after a certain period of time. Once orders are archived, no further notifications will be sent, and no updates to the tracking will be made.
:::
## How removing works
* If an order is unshipped, you can remove the order from Starshipit entirely.
* Orders removed from Starshipit can be re-imported from your eCommerce store later.
## Archive orders
1. Log into [Starshipit](https://app.starshipit.com/Account/MemberLogin.aspx) then go to **Orders**.
2. Select the orders you want to archive from the New, Printed or Shipped tabs.
3. Either right-click on the order or click the **Actions** menu.
4. Select **Archive**.
5. The order will now appear in the **Archived** tab and actions will not be able to be performed, e.g. you will not be able to print the label unless you restore the order.
## Restore archived orders
1. Log into [Starshipit](https://app.starshipit.com/Account/MemberLogin.aspx) then go to **Orders** > **Archived**.
2. Select the orders you want to restore.
3. Either right-click on the order or click the **Actions** menu.
4. Select **Restore**.
5. The order will now appear in the New, Printed, or Shipped tab and actions can be performed as normal.
## Remove orders
To remove orders there are two options: **Remove**, and **Remove all imported unshipped orders**.
:::note
If an order is unshipped, you can remove the order from Starshipit entirely. You cannot remove printed and shipped orders from Starshipit entirely, however, you can archive them.
:::
### Remove one or more unshipped order/s
1. Log into [Starshipit](https://app.starshipit.com/Account/MemberLogin.aspx) then go to **Orders** > **New**.
2. Select the orders you want to remove.
3. Either right-click on the order or click the Actions menu.
4. Select **Remove**.
### Remove all unshipped orders
1. Log into [Starshipit](https://app.starshipit.com/Account/MemberLogin.aspx) then go to **Orders** > **New**.
2. Make sure all unshipped orders you want to keep are marked as Saved.
3. Click on the Actions menu.
4. Select **Remove ALL imported unshipped orders**.
5. All orders will be removed, except those marked as Saved.
---
# Choose a web-app picking and packing workflow
URL: https://support.starshipit.com/articles/90200000000516-choose-a-web-app-picking-and-packing-workflow
Canonical: https://support.starshipit.com/articles/90200000000516-choose-a-web-app-picking-and-packing-workflow
Markdown: https://support.starshipit.com/articles/90200000000516-choose-a-web-app-picking-and-packing-workflow.md
Updated: 2026-07-20
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Choose a paper-based, barcode-assisted, packing-validation, or scale-assisted workflow in the Starshipit web app.
Choose how your team will pick and pack orders in the Starshipit web app. Barcode scanning is optional—you can use printed documents, scanning, USB scales, or a combination that matches your operation.
## Compare the workflows
| Workflow | Choose it when | Start with |
| --- | --- | --- |
| Packing slips | A picker or packer needs one document for each order. | [Print packing slips](/articles/90200000000515-print-packing-slips) |
| Packing summaries | Your team picks items for several orders in one batch. | [Print packing summaries](/articles/360001972155-print-packing-summaries) |
| Scan to open or print | You want to open or print an order by scanning its order barcode. | [Scan to open and print](/articles/360000984255-scan-to-open-and-print) |
| Packing Validation | A packer should scan each item to confirm the order is correct. | [Scan to validate items](/articles/6811966579215-scan-to-validate-items) |
| Tote picking | Pickers collect several orders and keep their items separated in physical totes. | [Scan totes for picking](/articles/12616572135055-scan-totes-for-picking) |
| Product-SKU printing | You ship many single-item orders and want a product scan to find the next matching order. | [Scan and print labels by product SKU](/articles/10931058747407-scan-and-print-labels-by-product-sku) |
| Scale-assisted packing | A packer weighs each completed package before printing its label. | [Weigh a package using USB scales](/articles/90200000000513-weigh-a-package-using-usb-scales) |
## Combine workflows
These options are not mutually exclusive. For example, your team can:
1. Print a packing summary for batch picking.
2. Move each order into a separate tote.
3. Scan each item with Packing Validation.
4. Weigh the completed package using USB scales.
5. Print the shipping label.
Start with the smallest workflow that solves the immediate problem. Add barcode scanning or hardware only when it removes a repeated manual step or reduces packing errors.
If your team wants to pick and pack from phones or tablets instead, use the [Starshipit Pick & Pack mobile app](/categories/orders-manifests-reports/starshipit-pick-and-pack).
---
# Choose where to use barcode scanning
URL: https://support.starshipit.com/articles/13207518443151-choose-where-to-use-barcode-scanning
Canonical: https://support.starshipit.com/articles/13207518443151-choose-where-to-use-barcode-scanning
Markdown: https://support.starshipit.com/articles/13207518443151-choose-where-to-use-barcode-scanning.md
Updated: 2026-05-06
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Barcode scanning in Starshipit helps your team pick, pack, and despatch faster with fewer mistakes. This guide covers where scanning is supported and how to get started.
## Barcode scanners and device support
Starshipit supports barcode scanning on both desktop and mobile devices.
**Desktop:** Starshipit supports any barcode scanner that acts as a keyboard input, including most USB and Bluetooth scanners. When you scan a barcode, the value is entered into the relevant field in the Starshipit web app. No setup is required beyond connecting the scanner to your device. We recommend using something similar to Zebra's [LS2208 General Purpose Barcode Scanner](https://www.zebra.com/ap/en/products/scanners/general-purpose-handheld-scanners/ls2208.html).
**Mobile:** The Starshipit Pick & Pack mobile app supports two scanning options:
- **Built-in camera:** Scan barcodes using your phone or tablet's camera.
- **Bluetooth scanner:** Pair a Bluetooth scanner with your device to scan barcodes through the mobile app.
## What you can do with barcode scanning
| Feature | Description | Supported on |
| --- | --- | --- |
| **Print an order** | Scan a barcode containing the order number or reference to automatically trigger label printing. [Set up scan-to-print](/articles/getting-started/barcode-scanning/scan-to-open-and-print) | Desktop & Mobile |
| **Validate items in an order** | Scan product barcodes during packing to confirm the correct items are included. [Validate items using barcode scanning](/articles/getting-started/barcode-scanning/validate-items-using-barcode-scanning) | Desktop & Mobile |
| **Select packages and carrier products** | Scan a barcode for each package and the correct package will be updated automatically. [Scan to select packaging and carrier products](/articles/getting-started/barcode-scanning/select-packaging-and-carrier-products-using-barcode-scanning) | Desktop & Mobile |
| **Find matching orders by product barcode** | Scan a product barcode to surface orders that contain only that product. [Scan and print labels based on product SKU](/articles/getting-started/barcode-scanning/scan-and-print-labels-based-on-product-sku) | Desktop |
| **Search for orders by order barcode** | Scan an order number or reference barcode to pull up the corresponding order. [Search for orders using barcodes](/articles/getting-started/barcode-scanning/workflows-to-streamline-your-order-fulfillment-process) | Desktop & Mobile |
| **Tote picking** | Assign totes to groups of orders in the mobile app, then scan the tote barcode to print labels or view contents. [Use tote scanning for picking](/articles/getting-started/barcode-scanning/tote-scanning-for-picking) | Assign: Mobile, Search & print: Both |
| **Scan GS1 barcodes** | Extract item details, quantities, and SSCC from a GS1 barcode and assign them to an order. | Mobile |
| **Attach tracking numbers** | Scan a tracking number (e.g. from a prepaid satchel) to attach it to an order. | Desktop |
| **Assign barcodes to products** | Add barcodes to your products using the Product Catalogue for use during packing validation. [Assign product barcodes in the Product Catalogue](/articles/integrations/product-catalogue/product-catalogue) | Desktop |
| **Add barcodes to documents** | Print barcodes on plain labels, packing slips, and packing summaries for scanning. [Add barcodes to printed documents](/articles/printing-labels-packing-slips/packing-slips-and-summaries/configure-packing-slips-using-the-template-editor) | Desktop |
| **Mark orders as delivered** | Scan the tracking barcode to mark orders as Picked Up or Delivered when using your own drivers. [Update tracking with plain labels](/articles/integrations/accounting-other-platforms/how-to-update-tracking-with-plain-labels-using-orca-scan) | Mobile (Orca Scan) |
## FAQs
What types of barcodes can I scan?
Starshipit supports standard barcode formats including Code128, EAN, and UPC. The mobile app also supports GS1 barcodes, and you can scan tracking barcodes from courier labels.
Can I use barcode scanning with my own systems via API?
Yes. The Starshipit API supports searching and updating orders using barcode values, generating packing slips with barcodes, and integrating GS1 barcode workflows. You can find our [Developer Center here](/developers).
---
# Print packing slips
URL: https://support.starshipit.com/articles/90200000000515-print-packing-slips
Canonical: https://support.starshipit.com/articles/90200000000515-print-packing-slips
Markdown: https://support.starshipit.com/articles/90200000000515-print-packing-slips.md
Updated: 2026-07-20
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Print packing slips for live orders individually, in bulk, or automatically with shipping labels.
Print packing slips while picking or packing orders in the Starshipit web app.
## Before you begin
[Configure packing slips](/articles/360000026636-configure-packing-slips) before using them in your live workflow.
## Print packing slips with labels
When **Print packing slips with each label** is enabled, fulfil and print the order normally. Starshipit sends the packing slip to the configured printer with the shipping label.
## Print packing slips separately
1. Open the unshipped orders grid.
2. Select the orders you are picking or packing.
3. Select the packing-slip print action.
4. Confirm the documents contain the expected orders and items before picking begins.
You can scan the order barcode on a packing slip using [Scan to open and print](/articles/360000984255-scan-to-open-and-print).
---
# Print packing summaries
URL: https://support.starshipit.com/articles/360001972155-print-packing-summaries
Canonical: https://support.starshipit.com/articles/360001972155-print-packing-summaries
Markdown: https://support.starshipit.com/articles/360001972155-print-packing-summaries.md
Updated: 2026-07-20
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Generate and print packing summaries for selected live orders during bulk picking and packing.
Generate a packing summary for selected orders when your team needs one document for bulk picking or packing.
## Before you begin
[Configure the packing summary](/articles/90200000000514-configure-packing-summaries) your team should use.
## Print a packing summary PDF
1. Open **Orders > New**.
2. Select the orders you want to pick or pack.
3. Click **Print packing summary**.
4. Confirm the PDF contains the expected orders and items.
## Download an unshipped packing summary CSV
1. Open **Reports**.
2. Click **Generate Report**.
3. Select **Unshipped Packing Summary Report**.
4. Choose whether to include child accounts and archived items.
5. Click **Generate**.
6. Download the report from the reports list.
---
# Use barcode scanning workflows
URL: https://support.starshipit.com/articles/6930264385295-use-barcode-scanning-workflows
Canonical: https://support.starshipit.com/articles/6930264385295-use-barcode-scanning-workflows
Markdown: https://support.starshipit.com/articles/6930264385295-use-barcode-scanning-workflows.md
Updated: 2026-05-06
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Starshipit Workflows help you process orders faster with barcode-driven search, scan-to-open/print, packing validation, and tote picking.
## How it works
Add these functions to your pick and pack workflow to save on clicks, get orders out the door quickly and improve your packing accuracy.
### Search for an order
Easily locate orders across your Starshipit account(s) by typing or scanning the order number or customer information.
1. Select **Search for an order**.
2. Enter/scan the order number, customer name or email you are searching for.
3. Click **Search**.
:::tip
Select **Include orders from child accounts** from the workflow options if you would like the search to include results from your child accounts.
:::
### Scan and open
Efficiently manage and customize your orders with Scan and open. Simply enter or scan an order number to access the order details page. From there, you can edit the order as needed and print it. This feature also includes the ability to open already printed orders and update packages by scanning barcodes.
To learn more:
- [Using a scanner to open and print your orders](/articles/getting-started/barcode-scanning/scan-to-open-and-print)
- [Select packages with a barcode scanner](/articles/getting-started/barcode-scanning/select-packaging-and-carrier-products-using-barcode-scanning)
### Scan and print
Save time and streamline your order fulfillment process with Scan and Print. Simply enter or scan an order number and the system will automatically print the corresponding order. This feature also includes options to allow printing of orders from child accounts and reprints of previously printed orders.
To learn more:
- [Using a scanner to open and print your orders](/articles/getting-started/barcode-scanning/scan-to-open-and-print)
### Validate items using barcode scanning
Ensure you're shipping the correct items with Packing Validation. This feature allows you to scan barcodes of the products in your order to validate they are correct. Use Scan barcodes to select packaging from the workflow options to easily select packages on the order details page with your scanner.
- [Validating your orders with Packing Validation](/articles/getting-started/barcode-scanning/validate-items-using-barcode-scanning)
- [Select packages with a barcode scanner](/articles/getting-started/barcode-scanning/select-packaging-and-carrier-products-using-barcode-scanning)
### Search and open/print order by product barcode
Speed up your packing process by scanning product SKUs. Simply scan a product's barcode, and the system will automatically find and print the label for the oldest unfulfilled single-item order containing that SKU. This feature eliminates the need for packing slips and helps you pack orders faster and more efficiently.
- [Print labels based on product SKU](/articles/getting-started/barcode-scanning/scan-and-print-labels-based-on-product-sku)
### Pack by tote
Tote picking organises orders by assigning a physical tote to each one. As you scan items, they're grouped under that tote, ensuring you know which items belong together. This simplifies handover between pickers and packers - each tote represents an order, allowing packers to scan it for packing details. Tote picking reduces packing errors, speeds up processing, and enhances accuracy in your workflow.
- [Tote picking in Starshipit](/articles/getting-started/barcode-scanning/tote-scanning-for-picking)
---
# Scan to open and print
URL: https://support.starshipit.com/articles/360000984255-scan-to-open-and-print
Canonical: https://support.starshipit.com/articles/360000984255-scan-to-open-and-print
Markdown: https://support.starshipit.com/articles/360000984255-scan-to-open-and-print.md
Updated: 2026-05-06
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Use Scan to Open and Scan to Print to quickly find orders and automatically print labels from a barcode scan.
## How it works
1. **Generate a Packing Slip:** A packing slip with a barcoded order number is required for the scan to open and scan to print workflows. You can generate packing slips in Starshipit by going to Orders, selecting the New tab, selecting the orders you want to generate packing slips for, clicking Print, and selecting Print Packing Slips.
2. **Scan the Packing Slip:** After picking and packing your items, go to **Workflows** and scan the barcode on the packing slip. This will initiate the scan to open or scan to print workflows, depending on your configuration.
3. **Select your scan option:**
1. **Print Order Directly:** The shipping label is printed immediately when a matching order is found.
2. **Open to Order Details:** When a matching order is found, the order details page is opened and you can make any necessary changes before printing the shipping label.
4. **Scan your barcode.**
5. **Press Enter.**
*Check your scanner manufacturer to see if adding an enter key function is possible after every scan.*
:::tip
**Reprint orders:** You can enable the option to allow orders that have already been printed to be reprinted by selecting "Include printed orders".
:::
:::tip
**Print orders from child accounts:**
1. Login to your parent account
2. Navigate to **Workflows**
3. Ensure you have selected **Scan and Print**
4. Tick **Include orders from child accounts**
5. Scan the order number and if a matching order is found, it will be printed
:::
:::note
If you use pre-paid labels with QR codes instead of barcodes, you will need a scanner that supports scanning QR codes.
:::
{{video:youtube:M0fPXU6NGY0}}
---
# Scan to validate items
URL: https://support.starshipit.com/articles/6811966579215-scan-to-validate-items
Canonical: https://support.starshipit.com/articles/6811966579215-scan-to-validate-items
Markdown: https://support.starshipit.com/articles/6811966579215-scan-to-validate-items.md
Updated: 2026-02-04
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Packing Validation lets you scan product barcodes to confirm items belong in the order, reducing packing errors and returns.
## How it works
1. Log in to your Starshipit account.
2. From the dashboard, navigate to the **Workflows** section on the left.
3. Select the **Packing Validation** option from the list of options.
4. Enter or scan the order number, then click **Search**.
5. The packing validation screen will open displaying the list of products in the order.
6. Scan the barcode or enter the SKU of each picked product/item. If the scanned barcode matches an item in the order, we'll mark that product as packed.
7. If you enter an item that is not in the order, you will be presented with an error on the screen.
8. Repeat step 6 for each item until all items have been packed.
9. The **Complete Packing** button will be enabled once you've scanned every product in the order to ensure you haven't missed anything.
10. Click **Complete Packing**. This will redirect you to the order details page.
11. Confirm the package and carrier/service selection.
12. Click **Print** to complete the packing validation for the ordered items.
1. Log in to your Starshipit account.
2. From the dashboard, navigate to the **Packing Validation** on the left.
3. Enter or scan the order number.
4. Click **Search**.
5. The packing validation screen will open displaying the list of products in the order.
6. Scan the barcode or enter the SKU of the picked product/item. If the scanned barcode matches an item in the order, we'll mark that product as packed.
7. If you enter an item that is not in the order, you will be presented with an error on the screen.
8. Repeat step 6 for each item until all items have been packed.
9. The **Complete Packing** button will be enabled once you've scanned every product in the order to ensure you haven't missed anything.
10. Click **Complete Packing**. This will redirect you to the order details page.
11. Confirm the package and carrier/service selection.
12. Click **Print** to complete the packing validation for the ordered items.
## Packing Validation settings
You can configure Packing Validation to fit your workflow by going to **Settings** > **Packing Validation**.
### Open orders with Packing Validation
Control how unshipped orders should open in the orders grid:
| Option | Description |
|--------|-------------|
| **Open the order details** | Opens the default Starshipit order details page |
| **Open the order with Packing Validation** | Takes you directly to the packing validation screen |
### Complete packing
Decide what happens when you click Complete Packing:
| Option | Description |
|--------|-------------|
| **Open the order details before printing the label** | Allows you to make any changes to your packaging or carrier selection before printing |
| **Print the label** | Prints the label directly once packing has been completed |
### Additional Options
**Auto-complete Packing Validation:** Enable this to automatically complete packing validation after the last item is scanned.
## FAQs
Is it possible to verify without SKU & barcode?
Yes, it is possible to verify items without SKU and barcode. You can either increase the quantity manually or use the **Mark as Packed** button to mark all ordered quantities as packed.
I don't have barcodes in Starshipit but I still would like to use validate my packing
Not every platform allows you to specify the barcode of your product. You can use the Starshipit product catalogue to upload all your barcodes so you can validate your packing even easier. For more information read our [support guide.](/articles/integrations/product-catalogue/product-catalogue)
How do I know when the wrong item has been scanned?
If the wrong item has been scanned, an error message will be displayed to the packer. The error message will indicate that the scanned barcode does not match the product's barcode. You can then take corrective action to ensure that the correct item is scanned and packed. Along with seeing an error message you will also hear an audio notification that will alert you when an incorrect item has been scanned.
Can I access Packing Validation from the Orders Grid?
Yes, it is possible to access Packing Validation from within the Orders Grid. You can right click on an order and select Open with Packing Validation to open the order directly within Packing Validation.
You can also configure your settings so all orders opened from the Orders Grid are opened with Packing Validation. To do this, go to Settings > Packing Validation and under Open orders with Packing Validation, select Open the order with Packing Validation.
Can I see when Packing Validation was used to pack an order?
Yes, it is possible see when Packing Validation was used to pack a shipped order. To see this, open any shipped order and scroll down to the History section. If Packing Validation was used to pack the order you will see a Packing Validation entry that logs when Packing Validation was used, and which items were packed.
---
# Scan and print labels by product SKU
URL: https://support.starshipit.com/articles/10931058747407-scan-and-print-labels-by-product-sku
Canonical: https://support.starshipit.com/articles/10931058747407-scan-and-print-labels-by-product-sku
Markdown: https://support.starshipit.com/articles/10931058747407-scan-and-print-labels-by-product-sku.md
Updated: 2026-05-06
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Streamline your packing process for single-item orders by scanning product barcodes to automatically find and process the correct order. This approach saves time and reduces errors.
Skip printing packing slips for single-item orders. Instead, grab a batch of products, bring them to your packing station, and scan each product's barcode. If an order exists for that item, the system will automatically print the shipping label, allowing you to immediately pack the item and apply the label.
## Key benefits
* **Eliminates packing slips:** No more printing and sorting packing slips for single-item orders.
* **Streamlines packing:** Simply scan the product, and the system finds and processes the matching order, printing the label automatically.
* **Boosts efficiency:** Reduces the time spent manually matching orders to products, allowing you to pack more orders, faster.
* **Minimises errors:** Ensures that the correct label is always applied to the right product, reducing packing mistakes.
## How it works
1. **Generate Packing Summary:** Start by generating a packing summary for all single-item orders in the system. This gives you a list of the SKUs you need to pick and bring to the packing station.
2. **Pick the Items:** Bring all the required SKUs to the packing station based on your summary. This allows you to process all the orders without needing to reference each individual packing slip.
3. **Select Workflow Mode:**
* Go to the **Workflows (UI 2.0)** or **Quick Print (classic UI)** page in Starshipit.
* Choose one of the following options:
+ **Scan and open based on product barcode:** This will open the oldest, unprinted order for that SKU.
+ **Scan and print based on product barcode:** This will automatically print the label for the oldest, unprinted order when the product's barcode is scanned.
4. **Scan the Barcode:** Scan the barcode of the product at your packing station. The system will automatically identify and retrieve the oldest order that hasn't been printed yet for that SKU.
5. **Automatic Order Handling:**
* If you chose **Scan and print**, the label will print immediately for the order.
* If you chose **Scan and open**, the order details will appear on-screen for further action.
6. **Finish packing:** When there are no remaining single-item orders for that SKU, you will receive an on-screen notification.
This workflow eliminates the need for you to manually look for packing slips or sort through multiple orders, speeding up your packing process and reducing errors.
## FAQs
What happens if the barcode doesn’t scan?
If a barcode does not scan, make sure the barcode label is clearly visible and undamaged. Also, check if the scanner is configured correctly for your system.
Can I use this for multi-item orders?
No, this feature is specifically for single-item orders. Orders with multiple items or multiple quantities of the same SKU are excluded.
If there are multiple order matches to that product SKU which will be used?
The oldest order with that product SKU will be selected.
Can I switch between multiple printing options?
Yes, you can always switch to a different packing method by changing the toggle options from the workflows/quick print page.
---
# Scan to select packaging and carrier products
URL: https://support.starshipit.com/articles/6930153486479-scan-to-select-packaging-and-carrier-products
Canonical: https://support.starshipit.com/articles/6930153486479-scan-to-select-packaging-and-carrier-products
Markdown: https://support.starshipit.com/articles/6930153486479-scan-to-select-packaging-and-carrier-products.md
Updated: 2026-05-06
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Use barcode scanning to select packages and carrier products faster and more accurately in UI 2.0.
{{video:youtube:JXEhgspFEU0}}
## Before you begin
Follow the steps below to set up your barcodes for both packages and carrier products:
1. **Create package barcodes**
1. [Set up your packages](/articles/orders-manifests-reports/orders/set-up-packages-and-import-weights-and-dimensions) in Starshipit if you haven't already done so, and create a barcode sheet with a barcode for each package.
2. Create a barcode sheet with a barcode for each package using the format: pkg_PackageName (where PackageName is the case-sensitive name you have assigned to each package in Starshipit). Any barcode that supports alphanumeric values will be valid.
2. **Create carrier product barcodes**
Create a barcode sheet with a barcode for each package using the format: prd_ProductCode (where ProductCode is the case-sensitive product code of the courier service you intend to use in Starshipit). Any barcode that supports alphanumeric values will be valid.
3. **Recommended equipment**
You will need a barcode scanner and a barcode sheet for all your packages and carrier products. Starshipit supports many types of scanners, but we recommend using something similar to the [LS2208 General Purpose Barcode Scanner.](/articles/getting-started/barcode-scanning/scan-to-open-and-print#:~:text=This%20workflow%20requires%20that%20you%20have%20a%20barcode%20scanner%2C%20and%20a%20packing%20slip%20with%20a%20barcoded%20order%20number%20displayed.%20You%20can%20use%20many%20different%20types%20of%20scanners.%20We%20recommend%20you%20use%20something%20similar%20to%20the%C2%A0LS2208%20General%20Purpose%20Barcode%20Scanner.)
4. **Optional setup**
You can print orders via a barcode scan by creating and scanning an **act_print** barcode to trigger the label printing process.
## How it works
This feature provides an additional input box in the bottom left of the order details page. To use it, follow these steps:
1. Navigate to the [Workflows](https://app2.starshipit.com/workflows) page in Starshipit.
2. Select **Scan and open**, **Search for an order** or **Packing Validation**.
3. From the Workflow options, tick **Scan to select packaging, carriers, and print labels**.
4. Scan the order number to open the order.
5. Scan the barcode of the package to assign the correct package to the order.
6. Scan the barcode of the carrier product to assign the shipping method.
7. (Optional) Scan the **act_print** barcode to print the order label.
8. Once the order is printed, you'll be redirected to Workflows to process your next order.
## Related workflows
Combine this feature with other barcode scanning workflows for maximum efficiency:
* [Workflows overview](/articles/getting-started/barcode-scanning/workflows-to-streamline-your-order-fulfillment-process)
* [Scan to open/print](/articles/getting-started/barcode-scanning/scan-to-open-and-print)
* [Packing Validation](/articles/getting-started/barcode-scanning/validate-items-using-barcode-scanning)
---
# Weigh a package using USB scales
URL: https://support.starshipit.com/articles/90200000000513-weigh-a-package-using-usb-scales
Canonical: https://support.starshipit.com/articles/90200000000513-weigh-a-package-using-usb-scales
Markdown: https://support.starshipit.com/articles/90200000000513-weigh-a-package-using-usb-scales.md
Updated: 2026-07-20
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Read a package weight from a connected USB scale while processing and printing an order.
Use a connected USB scale to apply the actual package weight while you pack and print an order.
## Before you begin
[Set up USB scales](/articles/6530818242831-set-up-usb-scales) and confirm the Desktop Print Application shows the scale as **Connected**.
## Weigh and print the package
1. Pack the order and place the complete package on the scale.
2. Open the order in Starshipit.
3. Click **Get Weight** in the bottom-left of the order.
4. Confirm the package weight updates to match the scale.
5. Review the selected package and courier service.
6. Click **Print**.
You can combine this with [Scan to open and print](/articles/360000984255-scan-to-open-and-print) to weigh packages as part of a barcode workflow.
---
# Understand the Starshipit Pick & Pack mobile app
URL: https://support.starshipit.com/articles/14427666806031-understand-the-starshipit-pick-pack-mobile-app
Canonical: https://support.starshipit.com/articles/14427666806031-understand-the-starshipit-pick-pack-mobile-app
Markdown: https://support.starshipit.com/articles/14427666806031-understand-the-starshipit-pick-pack-mobile-app.md
Updated: 2026-07-16
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Pick, pack, and print standard Starshipit orders from your mobile device with barcode scanning and real-time order updates.
Starshipit Pick & Pack helps you pick, pack, and print standard Starshipit orders from a mobile device. If your organisation uses Starshipit WMS, use [Starshipit WMS Mobile](/articles/14700000000023-setting-up-the-mobile-app) instead.
## Why use Starshipit Pick & Pack?
* **Work on the go** — pick, pack, and print orders anywhere in your warehouse.
* **Increase accuracy** — scan barcodes to validate items and reduce errors.
* **Reduce paper usage** — use digital picking and packing lists.
* **Boost efficiency** — cut down on manual data entry and streamline your workflow.
---
# Choose the right Starshipit mobile app
URL: https://support.starshipit.com/articles/90200000000301-choose-the-right-starshipit-mobile-app
Canonical: https://support.starshipit.com/articles/90200000000301-choose-the-right-starshipit-mobile-app
Markdown: https://support.starshipit.com/articles/90200000000301-choose-the-right-starshipit-mobile-app.md
Updated: 2026-07-16
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Compare Starshipit Pick & Pack and Starshipit WMS Mobile before downloading an app.
Starshipit has two mobile apps. Choose the one that matches the product your organisation uses.
## Compare the mobile apps
| If your organisation uses | Download | Use it to |
| --- | --- | --- |
| **Starshipit** for unshipped orders and shipping labels | **Starshipit Pick & Pack** | Pick and pack orders, validate products, add order statuses, and print shipping labels |
| **Starshipit WMS** for warehouse jobs, stock, and locations | **Starshipit WMS Mobile** | Complete WMS jobs, receive stock, put products away, replenish locations, manage inventory, pack orders, and create or print labels from the device |
[Set up Starshipit Pick & Pack](/articles/14427779060367-set-up-the-pick-pack-mobile-app) if you use standard Starshipit, or [set up Starshipit WMS Mobile](/articles/14700000000023-setting-up-the-mobile-app) if your organisation uses WMS.
If you are unsure whether you have WMS, ask your Starshipit administrator before downloading an app.
The apps use different desktop-printing behaviour. Pick & Pack can use a Print Client route configured in Starshipit when device printing is off. WMS Mobile prints directly through the device or creates the label without device printing; it does not use the Pick & Pack Print Client fallback. See [how Starshipit printing works](/articles/90200000000155-understand-how-starshipit-printing-works).
---
# Set up Starshipit Pick & Pack mobile app
URL: https://support.starshipit.com/articles/14427779060367-set-up-starshipit-pick-pack-mobile-app
Canonical: https://support.starshipit.com/articles/14427779060367-set-up-starshipit-pick-pack-mobile-app
Markdown: https://support.starshipit.com/articles/14427779060367-set-up-starshipit-pick-pack-mobile-app.md
Updated: 2026-08-17
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Install the correct Starshipit Pick & Pack app, sign in, choose a workflow, and configure scanning and printing.
Set up **Starshipit Pick & Pack** to pick, pack, validate, and print standard Starshipit orders. If your organisation uses WMS, use [Starshipit WMS Mobile](/articles/14700000000023-setting-up-the-mobile-app) instead.
## Watch the how-to video
{{video:youtube:-VokgCABUFM}}
## Set up in 5 steps
### Step 1: Download and install the app
Download **Starshipit Pick & Pack** for your device:
* **iOS (iPhone/iPad):** Download from the [Apple App Store](https://apps.apple.com/app/starshipit-pick-pack/id6502505197)
* **Android:** Download from the [Google Play Store](https://play.google.com/store/apps/details?id=com.starshipit.StarshipitMobile)
:::note
The iOS app isn't publicly listed in the App Store. You must use the direct link above to download it.
:::
### Step 2: Log in
Open the app and tap **Login to Starshipit**. Enter your Starshipit username and password, then tap **Login**.
### Step 3: Choose your workflow
The app will guide you through choosing which tabs you need:
| Workflow | What it does |
| -------- | ------------ |
| **Picking** | See unshipped orders that need to be picked. Adds a **picked** tag when complete. |
| **Packing** | See orders ready to pack. Can add a **packed** tag and create shipping labels. |
| **Validate (Printed)** | Validate orders with printed labels before dispatch. |
| **Validate (Shipped)** | Validate manifested/shipped orders as an extra audit step. |
**Common setups:**
* **Picking only:** For warehouse staff who pick items but don't pack or print labels.
* **Packing only:** For pack stations that receive picked orders and print labels.
* **Both:** For smaller operations where one person picks and packs.
:::note
If you enable both Picking and Packing, the Packing tab will only show orders with the **picked** tag (enforcing a two-stage workflow).
:::
### Step 4: Choose your packing mode
If you enabled **Packing**, choose how it behaves:
* **Pack picked orders only:** Only shows orders with the **picked** tag. Use this for two-stage pick-then-pack workflows.
* **Pack any unshipped order:** Shows all unshipped orders. Use this for simple one-stage packing.
### Step 5: Set up printing (optional)
If you will print labels while packing, first [understand how Starshipit printing works](/articles/90200000000155-understand-how-starshipit-printing-works), then choose one of these routes:
**Option A: Print from your mobile device**
1. Go to **Settings > Printing** in the app.
2. Turn on **Enable printing from this device**.
3. **Android:** Choose your printer in the system print dialogue when you print.
4. **iPhone:** Tap **Choose printer** to select an AirPrint printer.
**Option B: Print via desktop**
1. [Set up the Starshipit Desktop App in Print Client mode](/articles/360000693156-set-up-desktop-print-application#connect-the-desktop-app-as-a-print-client).
2. In the Starshipit web app, map the shipping label type to that Desktop App machine.
3. In the Desktop App, map the shipping label type to the physical printer you want that computer to use.
4. Leave **Enable printing from this device** turned off in the mobile app.
Turning device printing off does not choose a desktop printer. The label follows the printing route configured in your Starshipit account. If no Print Client route is configured, the mobile workflow can create the label without printing it.
## Verify printing
Run one test order through packing before processing live orders:
1. Create the shipment and label from Pick & Pack.
2. Confirm the label reaches the printer selected for your chosen route.
3. Check the label size, orientation, and content before attaching it.
If you use Print Client mode, also confirm the expected Desktop App machine shows **Online** in Starshipit and that the job did not print at another workstation.
***
## Optional configuration
These settings are not required but can enhance your workflow. Access them in **Settings** within the app.
### Scanning options
Configure how barcode scanning works:
* **Camera scanner** (default): Uses your device camera.
* **Physical scanner:** For Bluetooth scanners that send keyboard input. Hides the camera button and shows a text field instead.
* **Enable scanning only:** Requires all items to be scanned (no manual pick buttons).
### GS1 barcode processing
Enable this if you use GS1 barcodes to capture batch numbers, expiry dates, serial numbers, or SSCC codes.
### Device vs account-level settings
By default, each device has its own settings. If you want the same configuration across all devices:
1. Log in to the Starshipit web app as an admin.
2. Go to **Settings > Mobile app management**.
3. Enable account-level management and configure your defaults.
Devices will show "Settings managed by your organisation" for locked options.
### Key settings and other configuration options
All settings can be found in **Settings > Options**. These allow you to customise how the app behaves to fit your workflow. Some of these settings may be locked by your organisation if they are managed at account level.
| Setting | Description |
| ------- | ----------- |
| **Role & workflow** | Configure which tabs are available on this device:
• Picking
• Packing
• Validate (Printed)
• Validate (Shipped)
If Packing is enabled, choose whether to **Pack picked orders only** or **Pack any unshipped order**. |
| **Customise item attributes shown** | Choose which item details are displayed when picking and packing:
• SKU
• Bin
• Size
• Colour
• Barcode
• Weight
• Item image (thumbnail)
• Material
• Model
• Usage
• Brand
You can also enable **Consolidate items with same SKU/description** to group identical items.
For Material, Model, Usage, and Brand, each line appears on an item row only when the toggle is enabled and that item includes a value. |
| **Compact item rows** | Reduces item-row spacing and text size so more items are visible while picking or packing. This is useful for orders with many lines. Your selected item attributes and picking or packing controls remain available. |
| **Manual quantity adjustment** | By default, quantities are updated by scanning barcodes. Enabling this setting adds **+** and **-** buttons to the picking and packing screens.
Useful for handling partial shipments or when fine-tuned control over quantities is required. |
| **Print from the app** | Controls whether this device prints labels directly. Turn on **Enable printing from this device** to allow mobile printing.
When this is on, the device uses its operating-system print flow. When it is off, Pick & Pack can use the Print Client route configured in your Starshipit account, or create the label without printing.
See [how Starshipit printing works](/articles/90200000000155-understand-how-starshipit-printing-works) before choosing a route. |
| **Configure scanning** | Controls how scanning works in the app:
• **Use a physical scanner**: Removes the camera scan button and adds a text input field for Bluetooth scanners
• **On-screen keyboard**: Choose whether the keyboard appears when using a physical scanner
• **Auto-focus on search box**: Automatically focuses the search field when switching tabs
• **Enable scanning only**: Removes manual pick buttons, requiring barcode scanning for all items |
| **GS1 barcode processing** | When enabled, the app will parse GS1 barcodes and capture structured data:
• SSCC (Serial Shipping Container Code)
• Batch / Lot number
• Expiry / Best before date
• Production date
• Serial number |
| **Search result behaviour** | Controls what happens when an order number is scanned:
• **Open order directly** (default): Opens the matching order immediately
• **Show in list**: Filters and highlights the order so you can select it or build a batch |
| **Lock orders to current account** | When enabled, orders you start working on are "locked" to your account so other users cannot process the same order simultaneously. |
| **Nickname** | Set a nickname for your user. This name is used when tagging orders (e.g. "Packed by Alex"). If blank, your Starshipit account name is used. |
| **Theme** | Choose how the app looks:
• Light mode
• Dark mode
• Use device setting (follows your phone's system theme) |
| **Package scan behaviour** | Controls what happens when you scan a package barcode:
• **Add as an additional package**: Each scan creates a new package (for multi-parcel orders)
• **Replace the existing package**: Each scan updates the current package ID |
| **Picture of packed goods** | Controls whether users can or must capture photos during packing:
• **Enable picture of packed goods**: Shows an image section on the packing screen
• **Require photo before packing**: Makes at least one photo mandatory
Photos are stored against the order as a visual record. |
| **Tote settings** | Configure how totes (pick bins) are used:
• **Enable totes**: Turn tote functionality on or off
• **Default search on Packing**: Search by Tote ID or Order number
• **Tote restriction**: None (multiple orders per tote) or One order per tote
• **Must scan tote to place items**: Require tote barcode scan before placing items
See [Tote picking with the mobile app](/articles/getting-started/barcode-scanning/tote-scanning-for-picking) for more details. |
### Account-level (managed) configuration
If your organisation wants consistent settings across all users, some Pick & Pack options can be managed centrally at account level from the Starshipit web app.
* When a setting is managed at account level, devices will display a banner such as *“Settings managed by your organisation”* and the affected options will be read-only in the mobile app.
* Managed settings are applied to all devices using that Starshipit account (and any child accounts that inherit the configuration).
To manage settings at account level:
1. Sign in to the Starshipit web app as an account admin.
2. Open your account **Settings** and locate the configuration area for Pick & Pack / mobile app settings.
3. Configure the defaults you want to enforce (for example, scanning-only, whether packing must always print a label, or which workflows are available).
4. Save your changes. The next time users open the Pick & Pack app, their device-level settings will respect these managed values.
If you are an admin and are unsure where to find mobile managed settings, or you would like help enabling them for your account, contact Starshipit support.
---
# Choose a Pick & Pack mobile app workflow
URL: https://support.starshipit.com/articles/14427864973839-choose-a-pick-pack-mobile-app-workflow
Canonical: https://support.starshipit.com/articles/14427864973839-choose-a-pick-pack-mobile-app-workflow
Markdown: https://support.starshipit.com/articles/14427864973839-choose-a-pick-pack-mobile-app-workflow.md
Updated: 2026-06-15
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Choose the Pick & Pack workflow and optional features that match your warehouse setup.
Choose a workflow in the Pick & Pack mobile app based on how your team picks, packs, validates, and hands orders over for dispatch.
## Choose a workflow
Each device can use a different workflow. For example, pickers can use **Picking Only**, while packers or supervisors use **Picking and Packing** or **Packing Only**.
| Workflow | Best for | Things to consider |
| --- | --- | --- |
| **Picking and Packing** | Small teams or single operators who pick, pack, and print labels themselves. | Simple and fast with no handover. Works best when the same person can move between picking locations and packing benches. |
| **Picking Only** | Larger teams with dedicated pickers who prepare orders for a separate packing team. | Allows pickers to focus on accuracy and speed. Requires totes, carts, or a staging area to hand orders over clearly. |
| **Packing Only** | Storerooms, shop-floor fulfilment, micro-warehouses, or teams where picking and packing happen in the same place. | Skips a separate picked state. Staff scan items as they pack, which works best when stock is close to the packing bench. |
## Recommended feature choices
These optional features can improve speed and accuracy. You do not need all of them. Choose the ones that match how your warehouse operates.
| Feature | Recommended when | Why it helps |
| --- | --- | --- |
| **Tote Picking** | You pick multiple orders at once, pickers move with trolleys or carts, or you need clean separation between orders. | Keeps items grouped per order and reduces mis-picks. Works best with **One order per tote** and **Must scan tote to place items**. |
| **Bulk Picking** | You pick 5-20 orders from the same area, or SKUs are grouped together in your layout. | Reduces walking time by picking several orders in one pass. Best combined with tote picking. |
| **Enforce Scanning Only** | You want to avoid manual picking errors, all items have reliable barcodes, or staff rotate frequently. | Removes tap-to-pick actions so every item must be scanned. |
| **Package barcode scanning** | You ship multi-parcel orders, use barcoded satchels or cartons, or need parcel-level tracking. | Lets staff add or replace packages by scanning a package barcode. |
| **Picture of Packed Goods** | You ship high-value, fragile, or disputed items, or operate as a 3PL. | Stores photos against the order as proof. Use **Require photo** for strict audit requirements. |
| **Printed / Shipped Validation** | You need a final QC check before dispatch or many packers work at once. | Adds extra scanning steps to verify shipments before orders leave the building. |
| **GS1 barcode scanning** | You need to capture batch, expiry, serial, or SSCC details. | Reads GS1 data and attaches it to the order automatically. |
## Set up your team
1. Decide which workflow each role needs.
2. Configure each device for the workflow that role uses.
3. Enable only the optional features your team can consistently follow.
4. Run a test order through the workflow before using it for live orders.
## Follow a workflow
- [Picking and packing workflow](/articles/90200000000125-picking-and-packing-workflow)
- [Picking only workflow](/articles/90200000000126-picking-only-workflow)
- [Packing only workflow](/articles/90200000000127-packing-only-workflow)
## Related articles
- [Set up the Pick & Pack mobile app](/articles/14427779060367-set-up-the-pick-pack-mobile-app)
- [Using the Pick & Pack mobile app](/articles/14427860721423-using-the-pick-pack-mobile-app)
- [Pick & Pack mobile app printing troubleshooting](/articles/1776056162697-pick-pack-mobile-app-printing-troubleshooting)
---
# Pick and pack orders in the mobile app
URL: https://support.starshipit.com/articles/90200000000125-pick-and-pack-orders-in-the-mobile-app
Canonical: https://support.starshipit.com/articles/90200000000125-pick-and-pack-orders-in-the-mobile-app
Markdown: https://support.starshipit.com/articles/90200000000125-pick-and-pack-orders-in-the-mobile-app.md
Updated: 2026-06-15
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Pick, pack, print labels, and dispatch orders from one Pick & Pack mobile app workflow.
Use the picking and packing workflow when the same person or team picks items, packs orders, and prints labels in one end-to-end flow.
## Before you begin
Make sure your mobile device is charged, connected to Wi-Fi, and signed in to the correct Starshipit account. Set up your trolley, totes, cartons, and satchels. If this workflow prints labels, [choose and test the printing route](/articles/90200000000155-understand-how-starshipit-printing-works) before you start.
## Pick the order
1. Open the Starshipit Pick & Pack app.
2. Go to the **Picking** tab.
3. Use filters, sorting, or saved views to choose the orders you want to pick first.
4. Open an order or batch.
5. Tap the **barcode icon** and scan product barcodes or GS1 labels as you pick each item.
6. Tap **Complete picking** when every available item is picked.
If some items are not available, pick what you can and save the order as partially picked.
## Move to packing
Take the picked items or totes to your packing station. Completed picks appear on the **Packing** tab as ready to pack.
## Pack and print the label
1. Open the order from the **Packing** tab.
2. Scan the order barcode, scan the tote ID, or select the order from the list.
3. Scan each product as you place it into the carton or satchel.
4. Scan package barcodes if the order needs multiple parcels.
5. Capture photos of packed goods if your workflow requires proof of packing.
6. Tap **Complete packing** or the ship-and-print action.
7. Attach the printed label to the carton.
## Verify the order
Check that the order is no longer in the active picking or packing queue, the label printed correctly, and the shipment details are visible in Starshipit.
## Optional final checks
If your team uses validation tabs, use the **Printed** tab to check labelled cartons before dispatch and the **Shipped** tab to audit selected orders after manifesting.
## Related articles
- [Recommended Pick & Pack workflows](/articles/14427864973839-recommended-pick-pack-workflows)
- [Using the Pick & Pack mobile app](/articles/14427860721423-using-the-pick-pack-mobile-app)
- [Pick & Pack mobile app printing troubleshooting](/articles/1776056162697-pick-pack-mobile-app-printing-troubleshooting)
---
# Pick orders in the mobile app
URL: https://support.starshipit.com/articles/90200000000126-pick-orders-in-the-mobile-app
Canonical: https://support.starshipit.com/articles/90200000000126-pick-orders-in-the-mobile-app
Markdown: https://support.starshipit.com/articles/90200000000126-pick-orders-in-the-mobile-app.md
Updated: 2026-06-15
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Pick orders accurately in the Pick & Pack mobile app before handing them to a packing team.
Use the picking only workflow when dedicated pickers collect items and hand them to a separate packing team or packing system.
## Before you begin
Make sure your mobile device is charged, connected to Wi-Fi, and signed in to the correct Starshipit account. Prepare any totes, carts, or staging areas your team uses to separate picked orders.
## Choose orders to pick
1. Open the Starshipit Pick & Pack app.
2. Go to the **Picking** tab.
3. Filter by date, source, status, courier cut-off, or saved view.
4. Sort the list to match how your warehouse is set up.
5. Open the order you want to pick.
You can also scan an order barcode from a pick slip to jump straight into an urgent order.
## Pick the order
1. Use the order details screen as your digital picking list.
2. Tap the **barcode icon**.
3. Scan each product barcode as you move through the warehouse.
4. Check the picked quantity on screen.
5. Tap **Complete picking** when the order is ready for packing.
If stock is short, pick what you have and save the order as partially picked.
## Use batch picking and totes
For higher volumes, long-press an order to turn on multi-select, then choose a group of orders to pick together.
If your warehouse uses totes, assign one tote per order and place items into the correct tote as you move through each aisle.
## Stage picked orders
1. Move picked items, totes, or carts to the designated packing area.
2. Group work by courier, destination, cut-off time, or packing bench if useful.
3. Tell the packing team about any partial picks, damaged items, or missing stock.
## Verify the handover
Before you finish your shift, check the **Picking** tab for orders you started but did not complete. Confirm any remaining totes or carts are labelled and left in the correct area for packers.
## Related articles
- [Recommended Pick & Pack workflows](/articles/14427864973839-recommended-pick-pack-workflows)
- [Using the Pick & Pack mobile app](/articles/14427860721423-using-the-pick-pack-mobile-app)
- [Set up the Pick & Pack mobile app](/articles/14427779060367-set-up-the-pick-pack-mobile-app)
---
# Pack orders in the mobile app
URL: https://support.starshipit.com/articles/90200000000127-pack-orders-in-the-mobile-app
Canonical: https://support.starshipit.com/articles/90200000000127-pack-orders-in-the-mobile-app
Markdown: https://support.starshipit.com/articles/90200000000127-pack-orders-in-the-mobile-app.md
Updated: 2026-06-15
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Pack, validate, and print labels in the Pick & Pack mobile app when picking happens separately or nearby.
Use the packing only workflow when items arrive at a packing bench already picked, or when stock is close enough that packing and picking happen in one place.
## Before you begin
Make sure your packing bench has cartons, satchels, tape, and labels. If this workflow prints labels, [choose and test the printing route](/articles/90200000000155-understand-how-starshipit-printing-works) before you start. Open the Starshipit Pick & Pack app and go to the **Packing** tab.
## Open the order
1. Receive picked items in totes, on carts, or with printed pick slips.
2. Use filters, saved views, or search to find the order.
3. Scan the order barcode, scan the tote ID, or select the order from the list.
The order details screen shows all items and quantities expected in the shipment.
## Validate items as you pack
1. Tap the **barcode icon**.
2. Scan each product as you move it into the carton or satchel.
3. Scan GS1 barcodes when you need to capture batch, expiry, or serial details.
4. Pack only the available items if the order needs a partial shipment.
## Set packaging and parcels
1. Tap the **packaging** section and choose the right box or satchel.
2. Tap the **courier/service** section and choose the service for the shipment.
3. Scan package barcodes if the order needs multiple cartons.
These details are sent back to Starshipit so labels reflect the correct packaging and number of parcels.
## Complete packing
1. Capture photos of packed goods if your workflow requires proof of packing.
2. Tap **Complete packing** or the ship-and-print action.
3. Attach the printed label to the carton.
4. Move the carton to the dispatch area.
## Verify the shipment
Check that the label printed correctly, the order has moved out of the packing queue, and the shipment details are visible in Starshipit.
## Related articles
- [Recommended Pick & Pack workflows](/articles/14427864973839-recommended-pick-pack-workflows)
- [Using the Pick & Pack mobile app](/articles/14427860721423-using-the-pick-pack-mobile-app)
- [Pick & Pack mobile app printing troubleshooting](/articles/1776056162697-pick-pack-mobile-app-printing-troubleshooting)
---
# Use the Starshipit Pick & Pack mobile app
URL: https://support.starshipit.com/articles/14427860721423-use-the-starshipit-pick-pack-mobile-app
Canonical: https://support.starshipit.com/articles/14427860721423-use-the-starshipit-pick-pack-mobile-app
Markdown: https://support.starshipit.com/articles/14427860721423-use-the-starshipit-pick-pack-mobile-app.md
Updated: 2026-05-06
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Learn how to pick, pack, validate, and ship orders using the Starshipit Pick & Pack mobile app.
This guide covers everything you can do in the Pick & Pack mobile app – from finding orders and scanning items, to packing, validation and printing.
## App layout
The app is organised into tabs across the bottom of the screen:
* **Picking** – Unshipped orders that need to be picked.
* **Packing** – Orders that are ready to be packed and shipped.
* **Printed** – Orders with labels printed that are waiting for a final check (optional).
* **Shipped** – Orders that have been manifested/shipped and are available for audit (optional).
At the top of each tab you'll see:
* A **search bar** where you can type or scan order numbers, tracking numbers or tote IDs.
* **Filter** and **sort** options to control which orders you see and in what order.
Tapping an order opens the **order details** screen where you can:
* See a digital picking/packing list with item details.
* Tap the **barcode icon** to scan item or order barcodes.
* View and change packaging and courier service.
* Complete picking/packing, trigger label printing and, if enabled, capture photos of packed goods.
## Picking orders
How do I pick orders with barcode scanning?
Use the **Picking** tab to work through unshipped orders. Open an order and tap the **barcode scanner** icon to scan item barcodes. As you scan, the picked quantity updates against each line.
Once you've scanned everything, tap **Complete Picking**. The order status updates in Starshipit so it can move on to packing.
If your account uses strict barcode validation, you may need to scan every item rather than marking lines off manually.
Can I use the app as a digital picking list?
Yes. The order details screen shows item information such as SKU, description, quantity and other product details configured for your account.
As you move through the warehouse, use this digital list to guide which items to pick and how many are required—no paper picking slips needed.
How do I pick multiple orders at once (bulk/batch picking)?
**Long-press** on an order in the list to enable multi-select, then select several orders to pick in one batch.
When picking in bulk:
* Items with the same SKU across orders are grouped together, so you only walk to a location once.
* You can sort the combined item list by SKU or other attributes to optimise your route.
This is ideal for high-volume operations where you want to pick a batch of orders in one pass.
What if I can only pick some items now (partial picking)?
If not all items in an order are ready:
1. Open the order and scan or adjust quantities for the items you can supply now.
2. Choose **Save as partially picked** instead of completing picking.
3. The remaining items stay on the order so you can finish later when stock is available.
How do I use tote picking?
If your warehouse uses totes or bins, you can pick items straight into a tote:
1. Assign a tote to each order by scanning or entering a tote ID.
2. As you scan items, they're grouped under that tote.
3. At packing time, search by tote ID to bring up all orders/items in that tote.
See our [tote picking guide](/articles/getting-started/barcode-scanning/tote-scanning-for-picking) for more detail.
How do I delete an empty tote from Tote Details?
When totes are enabled, you can remove unused totes from the current device in the tote details screen.
1. Open **Order Processing**, then open the tote list.
2. Tap a tote to open **Tote Details**.
3. If the tote is empty and not marked full, tap **Delete this tote from this device**.
The delete action in this flow is shown for non-full empty totes. Full totes also include a delete action in the Tote Details modal.
## Packing and shipping
How do I pack orders with barcode validation?
In the **Packing** tab, open an order and tap the **barcode scanner** icon to confirm items as you pack them into cartons or satchels.
As you scan, the packed quantity updates against each line. When all items are accounted for, tap the button to complete packing. Depending on your setup, this may also create a shipment and label.
Can I partially pack an order?
Yes. If only some items are ready to send:
1. Scan or confirm the items you're sending now.
2. Use the **partial packing** option to create a shipment for those items.
3. Items not yet packed remain on the order for a future shipment.
This is useful for backorders or split shipments.
How do I change packaging or carrier?
On the order details screen:
* Tap the **packaging** section to change the carton or satchel.
* Tap the **courier/service** section to choose a different delivery service.
Changes are sent back to Starshipit so the correct packaging and service are used when the label is created.
How do I handle multi-package orders?
If an order ships in more than one carton or satchel, scan package barcodes while packing. The app will either:
* **Add a new package** to the order, or
* **Update the current package** with the scanned identifier.
The package count is displayed on the order and sent to Starshipit for label creation.
Can I capture photos of packed goods?
If your account uses photos during packing, an **image upload** section appears on the packing screen.
Use your device camera to take photos of items, the packed carton, or anything else you want recorded. Photos are stored against the order in Starshipit—useful for proof of packing and investigating claims.
How do I print labels from the app?
From the order, tap **Print** or the ship-and-print action. The app sends a request to Starshipit to create the shipment and label.
The destination depends on your printing setup:
* With **Enable printing from this device** on, the mobile device sends the label to its system print flow.
* With device printing off, the label can follow the Print Client machine route configured in the Starshipit web app. The Desktop App on that machine then sends it to its configured physical printer.
Once printed, the order status updates so your team can see it's ready to go.
See [how Starshipit printing works](/articles/90200000000155-understand-how-starshipit-printing-works) to set up or verify the route.
## Validation and accuracy
How do I validate printed orders?
If your account uses the **Printed** validation workflow, the Printed tab shows orders with labels printed but not yet dispatched.
Open an order to:
* Scan items in the carton and confirm they match the order.
* Review quantities and product details before the order leaves.
Mark the validation complete when you're satisfied.
How do I validate shipped orders?
If your account uses the **Shipped** validation workflow, the Shipped tab lists manifested orders available for audit. This is typically used for:
* Random spot checks
* Auditing high-value or high-risk orders
Review items and associated information, then mark validation complete.
How does GS1 barcode scanning work?
The app can scan and interpret **GS1 barcodes**. When you scan one:
* The GTIN is compared against the barcode stored on order items.
* If matched, the picked/packed quantity updates based on the quantity in the barcode.
* Additional data (serial number, batch number, expiry date, SSCC) can be captured and linked to the order.
Scanning the same GS1 barcode twice on an order triggers a warning to prevent duplicates.
How does order locking work?
To prevent two people working on the same order, the app can lock orders while processing.
When you start picking or packing:
* The order is marked as in use by your account.
* Other users will see it's being processed or won't see it as available.
This reduces duplicate work and conflicting updates.
## Finding and managing orders
How do I find orders by scanning barcodes?
Scan an order number or tracking barcode from a packing slip:
* Tap the **barcode icon** on the tab and scan with the camera, or
* Place the cursor in the search bar and scan so the order number is entered there.
Depending on your settings, this either opens the order immediately or highlights it in the list.
How do I filter and sort orders?
Use filters and sorting to prioritise work:
* **Filter** by date range, order source, or status.
* **Sort** by newest, oldest, most SKUs, or least SKUs.
This helps you focus on urgent orders first or group similar work together.
If your account has saved Starshipit filter views available, you can also apply them directly in the filter drawer:
1. Open **Picking**, **Packing**, **Printed**, or **Shipped**.
2. Tap **Filter**.
3. In the **Saved Views** section, tap a saved view chip.
4. The order list updates to that view's filters.
5. Tap **Clear** to reset.
Notes:
* The **Saved Views** section only appears when saved views are returned for your account.
* If you manually change filter values after selecting a saved view, the saved-view selection is cleared.
Can I switch between child accounts?
Yes. If your login has access to multiple child accounts (different stores or brands), go to **Settings** to:
* See which account you're currently using.
* Select a child account to view and process its orders.
* Switch back to the parent account when done.
Useful for 3PLs or multi-brand operations.
Are user names recorded for auditing?
Yes. When an order is picked or packed, Starshipit records who performed the action. In the web app you'll see events like:
* **Picked by [Name]**
* **Packed by [Name]**
This provides a clear audit trail for quality checks and investigations.
## App settings
Can I change the app theme?
Yes. The app supports **light** and **dark** themes. Choose the theme that works best for your environment—for example, dark mode in low-light warehouses—or follow your device's system theme.
How do I access error logs for troubleshooting?
The app includes an **Error Logs** screen:
* View recent errors that occurred on your device.
* Tap an entry to see details (error message, time, stack trace).
* Export logs via your device's share options to send to IT or Starshipit support.
* Clear logs when no longer needed.
Error logs are stored on-device only and are not automatically sent to Starshipit.
---
# Scan totes for picking
URL: https://support.starshipit.com/articles/12616572135055-scan-totes-for-picking
Canonical: https://support.starshipit.com/articles/12616572135055-scan-totes-for-picking
Markdown: https://support.starshipit.com/articles/12616572135055-scan-totes-for-picking.md
Updated: 2026-05-06
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Assign a physical tote to each order and scan items into totes to reduce packing errors and speed up handover between pickers and packers.
## What is tote picking?
Tote picking assigns a physical tote (bin or container) to each order while you pick. As you scan items, they’re grouped into that tote so you always know which items belong together.
It’s ideal when you have multiple pickers and packers, or when you want to reduce packing errors and speed up handover. Each tote clearly represents an order (or group of orders), so packers can scan the tote and see exactly what needs to be packed.
## Step 1: Set up your device
Before you start picking, open the Starshipit mobile app and go to: **Settings → Tote Settings**, then turn on:
* **Enable tote functionality during picking**
* **Packing tab default to tote scan** (optional – keeps you on the right screen when packing)
* **Restrict totes**
+ Choose **One order per tote** if you want to keep it simple.
+ Or **None** if you plan to group multiple orders into the same tote.
* **Must scan tote to place items** (optional – requires scanning a tote barcode each time you place an item, for extra accuracy)
## Step 2: Start picking
1. On your phone, head to the **Picking** tab.
2. Tap your orders, then hit **Begin Picking**.
3. If you have **One order per tote** enabled and you’re picking multiple orders (for example, 3 orders), the app will ask you to scan the same number of totes (3 totes).
1. Scan using a Bluetooth scanner, or type in the tote IDs.
2. Each scanned tote is automatically linked to one of the orders.
4. As you begin scanning items, the app automatically assigns them into the correct tote.
1. For each scan, you’ll see which tote the item belongs in.
2. Simply place the item into the tote as instructed.
5. If you enabled **Must scan tote to place items**, a modal will appear each time you need to place an item.
1. You’ll be prompted to scan (or type in) the tote ID before putting the item into the tote.
2. This adds an extra confirmation step to help reduce placement errors.
6. When you’re done, hit **Complete Picking**. The totes are cleared and ready for the next pick.
:::note
**Bonus: Managing your totes**
If you scroll to **All totes on this device**, you’ll see a list of all the totes you’ve been using. Tap a tote to:
- Switch between totes if you're picking for multiple orders.
- Remove an item from a tote if you made a mistake.
- Mark a tote as full so no one can add anything else to it.
- Unselect the active tote to stop picking into it.
:::
## Step 3: Pack the orders
1. Go to the **Packing tab** in the app.
2. Scan or type in the **tote ID**.
3. You'll only see orders linked to that tote.
4. Choose an order, validate the items, mark as packed and/or print your label, and you're done.
1. In the web app, go to [Starshipit Workflows](/articles/getting-started/barcode-scanning/workflows-to-streamline-your-order-fulfillment-process).
2. Make sure **Pack by Tote** is ticked.
3. Scan or type in the **tote ID**.
4. If there is:
- **One order in the tote** – it opens right away.
- **Multiple orders** – you'll choose which one to pack.
5. From here, you will land in our [packing validation screen](/articles/getting-started/barcode-scanning/validate-items-using-barcode-scanning) for you to scan each item and print the shipping label.
---
# Troubleshoot printing in the Pick & Pack mobile app
URL: https://support.starshipit.com/articles/1776056162697-troubleshoot-printing-in-the-pick-pack-mobile-app
Canonical: https://support.starshipit.com/articles/1776056162697-troubleshoot-printing-in-the-pick-pack-mobile-app
Markdown: https://support.starshipit.com/articles/1776056162697-troubleshoot-printing-in-the-pick-pack-mobile-app.md
Updated: 2026-05-06
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Troubleshoot common printing problems when using the Pick & Pack mobile app, including issues with the Starshipit Print Client and AirPrint.
Pick & Pack can print directly through your mobile device or send the job through the Print Client route configured in your Starshipit account. Use this guide to identify which route failed and restore printing.
## Before you start
First, confirm which route you use. See [how Starshipit printing works](/articles/90200000000155-understand-how-starshipit-printing-works) if you are unsure.
* Your printer has paper loaded and is not showing any error lights.
* For direct device printing, confirm the printer is available in the device's system print flow. AirPrint requires the iOS device and printer to be on the same network.
* For Print Client printing, confirm the selected Desktop App machine is online. The mobile device does not need to be on the same local network as that computer.
## Starshipit Print Client issues
Print Client jobs are routed through Starshipit. The Starshipit website setting selects the Desktop App machine that receives the job. That machine's Desktop App settings select the physical printer.
The label did not reach the expected Desktop App machine
The Pick & Pack app does not show Print Client machines in its device printer picker. Check the route in Starshipit instead:
1. Leave **Enable printing from this device** turned off in Pick & Pack.
2. In Starshipit, confirm the shipping label type uses **Print Client** and the expected machine is selected.
3. On that computer, confirm the Desktop App is running in Print Client mode and shows **Online**.
4. Send another print job after confirming the first job did not already create a label.
A print job is sent but nothing prints
1. Confirm Starshipit routed the shipping label type to the expected Desktop App machine.
2. In that Desktop App, confirm the label type is mapped to the correct physical printer.
3. Check the operating-system print queue and clear any stuck jobs.
4. Restart the Desktop App and send the job again.
Labels are printing at the wrong size
First check whether the generated PDF has the wrong format or the printer is scaling a correct PDF.
* If the PDF itself has the wrong layout, check the label format in the courier or Starshipit settings.
* If the PDF is correct, check the paper size, orientation, and scaling for that label route in the Desktop App and printer driver.
If labels are scaling incorrectly on a Mac, refer to [Mac: How to correct paper size to 4×6 (100×150)](/articles/troubleshooting/top-tips-for-troubleshooting-common-errors/mac-how-to-correct-paper-size-to-4x6-100x150) for CUPS configuration steps.
The Print Client keeps losing connection
1. Confirm the computer running the Desktop App has a stable internet connection.
2. Confirm the Desktop App still shows **Online** in Print Client mode.
3. Restart the Desktop App if it is offline, then check the machine assignment in Starshipit before retrying.
## AirPrint issues
AirPrint lets you print directly from your iOS device to a compatible printer on the same network, without needing the Print Client.
My printer is not appearing as an AirPrint option
1. Confirm your printer supports AirPrint. Check [Apple's AirPrint printer list](https://support.apple.com/en-au/111801) if unsure.
2. Make sure the printer and your iPhone or iPad are on the **same Wi-Fi network**. AirPrint does not work across different network segments.
3. Check your router's settings. Some routers have **AP isolation** (also called client isolation or guest network isolation) enabled, which prevents devices from communicating with each other on the same network. Disabling this should make the printer visible.
4. Restart the printer and retry.
A print job is sent but nothing prints
1. Check the printer is not in sleep mode or showing a fault light. Wake the printer or resolve any hardware errors (paper jam, low ink/toner) and try again.
2. Check the print queue on the printer's control panel or web interface and clear any stuck jobs.
3. Restart the printer and resend the job.
Labels are printing at the wrong size or are being scaled
AirPrint may apply scaling depending on the printer's default paper size. To correct this:
1. When sending the print job, tap **Options** in the print dialogue and confirm the correct paper size is selected.
2. Set the correct default paper size on the printer itself via its control panel or web interface.
:::note
For consistent label sizing with thermal printers, consider routing jobs through the Desktop App in Print Client mode. Configure both the machine route in Starshipit and the physical printer route in the Desktop App.
:::
Printing is slow or the app times out before printing finishes
This is usually caused by a weak Wi-Fi signal between your device and the printer.
1. Move your device closer to the Wi-Fi router or the printer.
2. Check that no other large print jobs are queued on the printer.
3. If the issue persists, restart your router, printer, and device.
## Still having issues?
If you have worked through the steps above and printing is still not working, [contact the Starshipit support team](https://help.starshipit.com) and include:
* The printing route you are using (direct device printing or Print Client).
* The make and model of your printer.
* A description of what happens when you try to print, including any error messages.
---
# Choose how to print shipping labels
URL: https://support.starshipit.com/articles/360000931116-choose-how-to-print-shipping-labels
Canonical: https://support.starshipit.com/articles/360000931116-choose-how-to-print-shipping-labels
Markdown: https://support.starshipit.com/articles/360000931116-choose-how-to-print-shipping-labels.md
Updated: 2026-09-03
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Learn the different ways to print shipping labels in Starshipit, including individual, bulk, auto, and scan-to-print methods.
Choose where to create shipping labels and how to send them to a printer. Starshipit supports one-at-a-time, bulk, automatic, scan-based, and mobile printing workflows.
## Before you begin
Before creating a label:
- [Connect your courier service](/categories/couriers).
- Check that the order has a valid shipping address.
- Decide whether to download the label, print from the device, or route it through the Starshipit Desktop App.
Read [Understand how Starshipit printing works](/articles/90200000000155-understand-how-starshipit-printing-works) before setting up direct printing. It explains the difference between choosing a receiving computer in Starshipit and choosing a physical printer in the Desktop App.
## Choose how the label reaches a printer
| Output method | Use it when |
| --- | --- |
| **Download PDF** | You want to save the label or choose a printer from your browser or PDF viewer. |
| **Desktop App routing** | A browser, workflow, or supported mobile app should send the label to a connected packing-station computer. Starshipit selects the receiving computer; that computer's Desktop App selects the physical printer. |
| **Print from this device** | A supported mobile app should use the device's system print flow, such as AirPrint on iOS. This bypasses Desktop App routing. |
The available methods depend on the Starshipit product and workflow where you create the label.
## Print your first shipping label
Open an order and select **Print label**. Starshipit creates the shipment, tracking number, and label, then uses the output method configured for that workflow. The order moves to **Printed** after the label is created.
Confirm both outcomes:
1. Check that the order has a shipment and tracking number.
2. Check that the label downloaded, opened in a print dialogue, or reached the expected printer.
{{video:youtube:_q6N-G_3w9M}}
## Print one or several orders
To print one order, select **Print** from the Orders grid or open the order and select **Print label**.
To bulk print, select the orders in the Orders grid and select **Print shipping labels**. Orders in the same bulk action must use the same courier service.
{{video:youtube:PyBjbU5DM4o}}
## Print and move to the next order
Use **Print and next** when you want to review and print orders individually without returning to the Orders grid after each one:
1. Open an order from the Orders grid.
2. Review the order details.
3. Select **Print and next** to print the label and open the next order.
{{video:youtube:S9uQd5ts83Y}}
## Print labels automatically
Use the Desktop App's auto-print workflow only when imported orders are ready to ship without individual review:
1. Open the Desktop Print Application.
2. Select **Tools** > **Auto Print**.
3. Enable automatic printing of unshipped orders.
4. Choose how often the app should check for new orders.
5. Choose whether to save each label PDF or send it directly to your mapped printer.
## Scan a packing slip to print
Scan the barcode on a packing slip to open the matching order and print its shipping label. This is useful when packing from printed documents or working at a dedicated packing station.
{{video:youtube:Z3QlhACQuqU}}
## Reprint a label
You can reprint a label after its shipment and tracking number have been created. Reprinting produces another copy of the existing label; it does not create a new tracking number.
If a shipment and tracking number exist but no paper label came out, reprint the existing label after fixing the output route. Do not create another shipment just to retry the physical print.
## Continue to manifesting
After printing, manifest the order to submit its shipment details to the courier for handover and billing. See [Manifest orders](/articles/360001233636-manifest-orders) for the next step.
---
# Print labels for partial shipments
URL: https://support.starshipit.com/articles/360001446756-print-labels-for-partial-shipments
Canonical: https://support.starshipit.com/articles/360001446756-print-labels-for-partial-shipments
Markdown: https://support.starshipit.com/articles/360001446756-print-labels-for-partial-shipments.md
Updated: 2026-05-07
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Learn how to split orders and create shipping labels for partial shipments in Starshipit.
{{video:youtube:RcrbhvOox2E}}
## Supported platforms
* BigCommerce
* Cin7 Omni
* Magento
* Magento 2
* Neto
* NetSuite
* Shopify
* TradeGecko
## Create a label for a partial shipment
1. In [Starshipit](https://app2.starshipit.com/), navigate to **Orders**.
2. Open the order you'd like to make a partial shipment for. It must have at least two items in it.
3. Clear the items that are not in stock or edit the quantity to be shipped.
4. Click **Print label**.
One part of the order will go to the **Printed** tab, and the rest of the items will be saved in a new order in the **New** tab. When the rest of the order is ready to be dispatched, another label can be printed.
:::note
The order in your eCommerce platform will also be partially shipped. Only the items shipped will be updated. If your eCommerce platform does not support partial shipping, the total order will be updated when you print the first label.
:::
---
# Cancel or archive shipping labels
URL: https://support.starshipit.com/articles/12936466001295-cancel-or-archive-shipping-labels
Canonical: https://support.starshipit.com/articles/12936466001295-cancel-or-archive-shipping-labels
Markdown: https://support.starshipit.com/articles/12936466001295-cancel-or-archive-shipping-labels.md
Updated: 2026-05-07
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Learn how to cancel or archive shipping labels in Starshipit, including supported carriers and when to contact your courier directly.
## Cancellation options with Starshipit
### 1. Before manifesting
If the order hasn't been manifested:
1. In Starshipit, go to the **Orders** screen.
2. Select the order with the label you want to cancel.
3. Click **Actions** and choose **Archive**.
Archiving removes the order from your active orders list but retains it in your records.
:::warning
Archiving does not cancel the label or refund shipping fees. You must cancel the label through the carrier settings in Starshipit or the carrier's portal (where applicable).
:::
### 2. After manifesting
:::warning
**Before cancelling a label, make sure you're cancelling the right one!**
If you've reprinted, cloned, or redone a label, there may be multiple labels for the same order. Don't rely solely on the Starshipit app to determine which tracking number to cancel (e.g. cancelling the one in the Archive tab). It's possible that the archived label was the one actually applied to the parcel.
Cancelling a label that's already in the delivery network can lead to the parcel still being delivered and may incur return-to-sender fees or penalties. Always check which label was applied, ideally by checking the physical parcel before cancelling.
:::
If the order has already been manifested:
* You must **contact your carrier directly** to request cancellation. Some carriers still allow cancellations post-manifest if the parcel hasn't been scanned.
* To cancel the shipment in Starshipit (where supported), go to:
1. **Settings** > Your Carrier **Settings** > **Tools**.
2. Enter the tracking number to cancel the shipment.
## Why you can't delete printed labels
Once a label is printed, Starshipit retains it for the following reasons:
* **Record keeping**
It ensures you have a reference in case the shipment goes out unintentionally.
* **Carrier compliance**
Carriers may require a valid tracking reference for shipments, even if unmanifested.
If you’ve made a mistake:
* **Redo the shipping** by creating a new label.
* **Archive** the incorrect order.
:::note
Re-doing shipping may trigger writeback to your eCommerce platform (e.g., Shopify or WooCommerce). Ensure you're aware of the impact this could have on fulfilment statuses.
:::
## FAQs
**Can I cancel a label after it’s printed?**
Yes, but only if the order hasn't been manifested. You can archive it from the Orders screen. If it has been manifested, you’ll need to contact your carrier.
**Why can’t I delete a label in Starshipit?**
For compliance and technical reasons, Starshipit does not allow deletion of labels. They are also retained to prevent issues for example, if they end up in the courier system. This ensures you have tracking and manifest options if needed.
**Will cancelling a label trigger a writeback?**
Archiving does not trigger a writeback. However, redoing shipping might, depending on your integration settings.
---
# Troubleshoot printing
URL: https://support.starshipit.com/articles/213724603-troubleshoot-printing
Canonical: https://support.starshipit.com/articles/213724603-troubleshoot-printing
Markdown: https://support.starshipit.com/articles/213724603-troubleshoot-printing.md
Updated: 2026-09-03
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Find where label creation or printing stopped, then fix the affected routing or printer stage.
Use this guide to identify the stage where printing stopped. A print action can create a shipment successfully even when the label never reaches a physical printer.
Read [Understand how Starshipit printing works](/articles/90200000000155-understand-how-starshipit-printing-works) if you are unsure how the trigger, receiving computer, Desktop App, and physical printer fit together.
{{video:youtube:rD3ZjpUbV_M}}
## Check whether the label was created
Open the order and look for a shipment, tracking number, or existing label.
- **No shipment or label exists:** Starshipit did not complete label creation. Read the error shown on screen, then check the order address, package, carrier service, and courier credentials before retrying.
- **A shipment and label exist:** Label creation succeeded. Do not create another shipment. Continue below to find where delivery or physical printing stopped.
## Fix “Could not find the Label Type for courier:-1”
This error can occur during bulk printing when an order does not have a courier and service assigned.
1. Find the affected order in the Orders grid.
2. Confirm the **Courier** and **Product** columns show the intended courier and service.
3. Assign the missing courier and service to the order.
4. To assign them automatically on future imports, configure a [shipping rule](/articles/115001575803-rules-overview) or [default courier service](/articles/203889659-set-a-default-courier-service).
5. Retry the bulk print.
## Fix error 100141
An unsupported or invisible character in an order field can cause error `100141` during label creation. Check fields such as the receiver name, company, and address lines.
1. Open the order and inspect the affected fields for unexpected symbols or extra spaces.
2. Retype the affected value manually using plain text. If the problem is not visible, paste the value into a plain-text editor to inspect it, then retype it in Starshipit.
3. Save the order.
4. Confirm that no shipment or tracking number was created, then retry printing the label.
## Check the selected output method
Confirm what should have happened after the label was created:
| Expected output | Check next |
| --- | --- |
| A PDF should download | Check the browser's download list and whether downloads are allowed for Starshipit. |
| A browser print dialogue should open | Check whether the browser blocked the new window or print dialogue. |
| A Desktop App computer should receive the job | Check the receiving machine selected in Starshipit, then check that machine's Desktop App connection. |
| The current mobile device should print | Check the app's device-print setting, the system print service, and the selected printer. |
## Separate packing slips from shipping labels
If packing slips are combined with shipping labels but you need separate output, give **Packing Slip** its own print setting:
1. In Starshipit, go to **Settings > Printing > Advanced**.
2. Add or open the **Packing Slip** print setting.
3. Choose **Download PDF** to download packing slips as a separate file, or choose the Print Client route and select the Desktop App computer that should receive them.
4. For Print Client output, open **Print Settings** in the Desktop App on that computer and map **Packing Slip** to the required printer.
5. Reprint an existing packing slip and confirm that it reaches the expected destination.
## The wrong computer receives the job
For Desktop App routing, Starshipit settings choose the receiving computer. The Desktop App on that computer then chooses the physical printer.
1. In Starshipit, go to **Settings > Printing > Advanced**.
2. Open the settings for the affected label or document type.
3. Confirm **Print Method** uses the Print Client route.
4. Confirm **Machine** is the computer that should receive the job.
5. Confirm the Desktop App is open and connected on that computer.
If the correct computer receives the job but the wrong printer is used, follow [Troubleshoot the Starshipit Desktop App](/articles/360001591615-troubleshoot-the-print-app).
## The correct computer receives the job but nothing prints
This is a local Desktop App, operating-system, or printer issue. Check the Desktop App's document and label routes, then print the downloaded label PDF directly to the same printer.
- If the PDF also fails, check the operating-system print queue, printer connection, driver, paper, and error indicators.
- If the PDF prints, troubleshoot the Desktop App's local printer mapping.
## The label prints from the wrong physical printer
Open **Print Settings** in the Desktop App on the receiving computer. Confirm the affected document default or shipping-label route points to the intended physical printer.
Changing the machine in Starshipit sends the job to a different computer. Changing the printer in the Desktop App changes the printer used by that computer.
## A mobile device does not print
First confirm that the app is configured to print from the device. Device printing uses the operating system's print flow and does not use the Desktop App machine route.
1. Confirm the expected printer or print service is available to the mobile device.
2. On iOS, confirm the expected AirPrint printer is selected.
3. Confirm the device can reach the printer on the network.
4. Check whether the shipment and tracking number were already created before retrying.
Use the troubleshooting guide for the app where you started the print:
- [Troubleshoot printing in the Pick & Pack mobile app](/articles/1776056162697-troubleshoot-printing-in-the-pick-and-pack-mobile-app)
- [Troubleshoot Starshipit WMS Mobile](/articles/14700000000038-troubleshoot-starshipit-wms-mobile)
## Labels print at the wrong size or orientation
Check the settings at each stage:
1. Confirm the courier or label format is correct in Starshipit.
2. For Desktop App printing, confirm the paper size and orientation on the affected document or shipping-label route.
3. Confirm the operating-system printer preferences use the same paper size.
4. Confirm the loaded label stock matches that size.
5. Calibrate the printer if output is offset or crosses label boundaries.
## Fix DHL Express labels that use the wrong length
If only DHL Express labels use 100 x 200 mm instead of 100 x 150 mm, change the courier-specific resize setting:
1. Go to **Settings > Couriers > DHL Express > Advanced**.
2. Enable **Resize 100x200 labels to 100x150**.
3. Save the DHL Express settings.
4. Reprint an existing label and confirm it fits the 100 x 150 mm stock.
## Reprint after fixing the problem
If the shipment and tracking number already exist, use the order's **Reprint** action. Reprinting sends another copy of the existing label and does not create a new tracking number.
After reprinting, confirm:
1. The expected computer or device receives the job.
2. The expected physical printer is used.
3. The barcode, size, and orientation are correct.
---
# Troubleshoot the Starshipit Desktop App
URL: https://support.starshipit.com/articles/360001591615-troubleshoot-the-starshipit-desktop-app
Canonical: https://support.starshipit.com/articles/360001591615-troubleshoot-the-starshipit-desktop-app
Markdown: https://support.starshipit.com/articles/360001591615-troubleshoot-the-starshipit-desktop-app.md
Updated: 2026-09-03
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Fix local printer mapping, output, size, and connection issues in the Starshipit Desktop App.
Use this guide after confirming that the label was created and reached the correct computer. It covers the local step from the Starshipit Desktop App to a physical printer.
If no shipment or label exists, or the wrong computer receives the job, start with [Troubleshoot printing](/articles/213724603-troubleshoot-printing). For the complete routing model, see [Understand how Starshipit printing works](/articles/90200000000155-understand-how-starshipit-printing-works).
## Check the local print route
1. Open the **Starshipit Desktop App** on the computer that received the job.
2. Open **Settings**, then select **Print Settings**.
3. Under **Document Defaults**, check whether the affected document should use a printer or download as a PDF.
4. If it uses a printer, confirm the expected physical printer is selected.
5. Under **Shipping Label Type Routes**, confirm any matching label-type route uses the intended printer, paper size, and orientation.
Starshipit website settings select which Desktop App computer receives a routed job. These Desktop App settings select what that computer does with it.
## The Desktop App receives the job but nothing prints
1. Download or open the existing label PDF.
2. Print it directly to the same physical printer.
3. Check the result:
- If the PDF does not print, clear any stuck jobs in the operating-system print queue and check the printer connection, driver, paper, and error indicators.
- If the PDF prints, return to **Print Settings** in the Desktop App and correct the route for that label or document type.
Contact your IT team or printer manufacturer if the operating system cannot print the PDF.
## The wrong physical printer is used
Open **Print Settings** and update the affected **Document Default** or **Shipping Label Type Route**. A specific shipping-label route can override the general document destination.
If the job reached the wrong computer rather than the wrong printer, change the **Machine** for that label or document type in Starshipit **Settings > Printing > Advanced**.
## The Desktop App downloads a PDF instead of printing
Open **Print Settings** and check the affected document default or shipping-label route. Change its destination from PDF download to **Printer**, then select the required printer.
If the Desktop App setting already uses a printer, check whether Starshipit or the originating workflow was deliberately configured to download or open the label instead of routing it to the Desktop App.
## The label only prints for the first order
More than one Desktop App installation can cause this behavior on Windows. Before reinstalling, confirm the later jobs reached this computer and are not waiting in the operating-system print queue.
1. Open Task Manager (Keyboard shortcut: Ctrl + Shift + Esc).
2. Right-click on **StarshipitDesktop.exe** and select **Open File Location**.
3. Move to the previous folder named **Starshipit**.
4. While keeping this folder open, uninstall the Desktop App using **Add or remove programs**.
5. After uninstalling the app, delete the **Starshipit Desktop** folder.
6. Reinstall the Starshipit Desktop App. You can download this by navigating to **Starshipit** > **Settings** > **Printing**.
## Labels use the wrong size, orientation, or duplex setting
1. In **Print Settings**, open the route for the affected label or document.
2. Confirm the paper size and orientation match the label stock loaded in the printer.
3. Open the operating-system printer preferences and confirm the same paper size.
4. Disable double-sided printing for labels and packing documents that must print one-sided.
5. Calibrate the printer if output is offset or crosses label boundaries.
On macOS, see [Fix 4 x 6 label paper size on Mac](/articles/4408869188239-fix-4-x-6-label-paper-size-on-mac) if the operating system continues to scale the label incorrectly.
## The save button doesn't save my printer settings
On Windows, check whether the Desktop App can save its local settings:
1. Open Task Manager (Keyboard shortcut: Ctrl + Shift + Esc).
2. Right-click on **StarshipitDesktop.exe** and select **Open File Location**.
3. Right-click on the **StarshipitDesktop** application and select **Properties**.
4. Under the Compatibility tab, tick the **Run this program as an administrator** box, click **Apply** then **OK**.
5. Close the Desktop app, open it again and you should now be able to save your printing settings.
## Confirm the fix
Reprint an existing label and confirm:
1. The Desktop App receives the job.
2. The expected physical printer is used.
3. The label uses the correct size and orientation.
4. The barcode is clear and scannable.
---
# Fix 4 x 6 label paper size on Mac
URL: https://support.starshipit.com/articles/4408869188239-fix-4-x-6-label-paper-size-on-mac
Canonical: https://support.starshipit.com/articles/4408869188239-fix-4-x-6-label-paper-size-on-mac
Markdown: https://support.starshipit.com/articles/4408869188239-fix-4-x-6-label-paper-size-on-mac.md
Updated: 2026-05-07
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> How to set up your default printer settings on Mac so that labels print at the correct 4x6" (100x150mm) size.
This guide will help you set up your default printer settings so that labels print at the correct size of 4x6" (100x150mm). For the purposes of this guide, we will be using a DYMO printer, however the CUPS steps should apply for any thermal printer.
Before you begin, please ensure you have already installed the printer driver software on your Mac computer.
## How it works
1. Check that CUPS is running on your Mac OS
To verify that CUPS is running open your web browser and paste the following into the address bar: ****
* If you encounter no error, then you have verified CUPS is running
* If you encounter a "Web Interface is Disabled" error:
1. Open your Terminal Application on your **Mac Finder** > **Applications** > **Utilities**
2. Type the text below in the terminal and click enter:
```
cupsctl WebInterface=yes
```
3. Type the text below in the terminal and click enter:
```
cupsctl
```
4. If it shows with an entry stating "WebInterface=yes" then it is now enabled
2. Navigate to **WebInterface**
1. Open your web browser and paste the following into the address bar: ****
2. Select your DYMO_Labelwriter_4XL printer in the list that shows.
3. After selecting the printer you will be presented with a summary. From here, select **Set Default Options**in the dropdown.:** **
4. You will be presented with a new screen that has the option **Media Size**.
5. Change this option to the correct paper size for your DYMO, this is usually 4x6"(100x150mm).
6. Then select **Set Default Options**.
7. You may be presented with an "Authentication Required" screen, enter your computer's username and password and **Log In**.
Now, when you print with your DYMO LabelWriter 4XL, the labels should be in the correct format.
:::note
If the 100x150 size does not show under Media Size you may need to download and install thelatest Dymo softwareunder The Latest Software & Drivers for all Label Writers and Label Manager,then remove and re-add your printer.
:::
---
# Troubleshoot the legacy Print Client
URL: https://support.starshipit.com/articles/360000994896-troubleshoot-the-legacy-print-client
Canonical: https://support.starshipit.com/articles/360000994896-troubleshoot-the-legacy-print-client
Markdown: https://support.starshipit.com/articles/360000994896-troubleshoot-the-legacy-print-client.md
Updated: 2026-05-07
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Troubleshoot common errors in the legacy Starshipit Print Client and learn when to contact support.
:::warning
This article applies only to the standalone legacy Print Client. The current Desktop App can receive jobs from Starshipit in Print Client mode and map them to local printers. For a new setup, follow [Set up the Starshipit Desktop App](/articles/360000693156-set-up-desktop-print-application).
Do not run both clients for the same machine and account.
:::
## Check Print Client communication
1. Open the **Print Client** application on your computer.
2. Go to the **Logs** tab.
3. Look for an entry that says "Downloading label".
* **If you see this entry**: This confirms that your Starshipit account is communicating with the Print Client successfully. The issue may lie with the printer connection or printer settings (see Step 2).
* **If you do NOT see this entry**: It's likely that the Print Client is not connected properly. [Verify the machine setup](#verify-machine-name-in-starshipit-settings) in your Starshipit account.
## Verify Machine Name in Starshipit Settings
If your Starshipit account is not communicating with the Print Client:
1. Go to your Starshipit **account settings**.
2. Navigate to **Settings** > **Printing** > **Advanced**.
3. Reconfirm the **M****achine** name listed under your label types.
* This name must match the name of the computer running the Print Client.
## Error: Your labels aren't coming out of the printer
Close and reopen the Print Client
1. Navigate to the taskbar (Windows), or menu bar (Mac)
2. Click the arrow icon, then select the **Starshipit Print Client**.
3. Right-click, then select **Exit** or **Quit** to close the Print Client.
4. If the Print Client is frozen, end the process from your task manager.
5. Re-open the **Starshipit Print Client**. When you reopen the client, you will be asked to log back in with your authorisation code. See [I can't find the authorisation code](#error-i-cant-find-the-authorisation-code).
6. Once logged in again, check that the machine name selected in Settings > Printing > Advanced matches the machine name in the print client. For help on finding your machine name, see our guide on [finding your computer name.](/articles/printing-labels-packing-slips/printing/find-your-computer-name)
## Error: Your account is using the wrong print settings
If you have a child account you may be finding that the printer you want to use is not selected. If that is the case then:
1. Log out of Starshipit completely
2. Log back into the child account directly, **do not override the parent account**
3. Go to **Settings** > **Printing** > **Advanced** > **Settings** under a label type or **Add new print settings** and copy the authorisation code. For more information, see [I can't find the authorisation code](#error-i-cant-find-the-authorisation-code).
4. Log out of the print client:
1. Right-click the icon in the taskbar
2. Select Open Print Client
3. Click the blue **Logout** option
4. Log back in using the authorisation code from Step 3
5. If this has worked, the account tab should have the username of the child account, not the parent account
## Error: I can't find the authorisation code
When you open the print client, you will be asked for the authorisation code. To locate this:
1. Log into [Starshipit](https://app2.starshipit.com/)
2. Go to **Settings** > **Printing** > **Advanced** > **Settings** under a label type or **Add new print settings**
3. You will then see the authorization code you can use to log into the app.
## Error: Your Starshipit Print Client is cutting out
As the standalone Print Client is a legacy application, upgrade to the [Desktop App's Print Client mode](/articles/360000693156-set-up-desktop-print-application#connect-the-desktop-app-as-a-print-client) for a supported current setup.
---
# Troubleshoot Zebra barcode printing
URL: https://support.starshipit.com/articles/9754350032271-troubleshoot-zebra-barcode-printing
Canonical: https://support.starshipit.com/articles/9754350032271-troubleshoot-zebra-barcode-printing
Markdown: https://support.starshipit.com/articles/9754350032271-troubleshoot-zebra-barcode-printing.md
Updated: 2026-05-07
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> How to fix Zebra printer barcodes that appear as large blocks and are not scannable by installing alternative drivers.
When printing with a Zebra Printer your barcode may appear as large blocks which are not scannable.
To resolve this issue you must download and install the [Zebra Alternative drivers](https://www.zebra.com/us/en/support-downloads/printers.html).
1. On Zebra's support page, input your **Printer Model** and select it from the options that appear.
2. Expand the **Drivers** option.
3. Download and install the alternative driver for your operating system.
4. During installation wizard, you must specify your printer model correctly.
If the printer is already installed and you find that you have two versions of the printer installed now, remove the newly installed version of the installed printer via the Printers & Scanners setting.
---
# Shipping label FAQs
URL: https://support.starshipit.com/articles/360000928236-shipping-label-faqs
Canonical: https://support.starshipit.com/articles/360000928236-shipping-label-faqs
Markdown: https://support.starshipit.com/articles/360000928236-shipping-label-faqs.md
Updated: 2026-05-20
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Find answers to frequently asked questions about shipping labels.
{{video:youtube:eOGpipYZ6UQ}}
How do I re-print a label?
1. From the main menu, select **Orders**, then select the **Printed** tab.
2. Select the order for the label you want to re-print.
3. In the right-hand corner, click **Re-print**, then select **Re-print shipping label**.
How do I replace a label?
You use the re-do functionality to replace an existing label. Use this when you have made a mistake with the order, such as entering an incorrect address.
1. From the main menu, select **Orders**, then select the **Printed** tab.
2. Select the order for the label you want to re-do.
3. In the right-hand corner, click the re-print drop down.
4. Select **Re-do shipping**, then click **Redo** to confirm.
The order will move to the **New** unshipped tab. The order version which was initially printed will be moved to the archived tab.
How do I clone an existing order?
Use the add shipment functionality to clone an existing order. This is useful when you are sending the same order to a customer.
1. From the main menu, select **Orders**, then select the **Printed** tab.
2. Select and open the order for the label you want to re-print.
3. Click **Clone**, and select either:
* **Show in table** to move the order to the New tab.
* **Open order** to open the cloned order.
How do I print multiple labels for one shipment?
Print multiple labels when you need to send more than one parcel to a customer.
1. From the **Orders** page, open the order you want to print multiple labels for.
2. Under **Parcels**, enter the number of labels you want for each box in the **QTY** column. You can print labels for parcels with the same weight and dimensions, or parcels with different weights and dimensions.
3. Click **Print Labels**.
:::note
Multi-package shipments are not supported by all couriers and services. If you see an error when printing, check your courier guide (many include a multi-package section) or contact [support](https://help.starshipit.com).
:::
For example, two boxes with same weight and same dimensions:
Note: The weight displayed is the weight per box.
Can I add a logo to the shipping label?
You can only add a business logo on your labels if you are a DHL Express customer and you are on a **[Professional or above plan](/articles/settings-billing-security/billing/about-our-pricing-plans)**. To add your logo:
1. Go to **Settings**, then select **Couriers**.
2. Select DHL Express from the list, then select the **Advanced** tab.
3. Select the **Display Custom Logo on labels** checkbox, and upload your custom logo.
The maximum file size is 1MB, Width 354px, Height 177px, Resolution: 300 dpi.
Can I create a label for a partial shipment?
Yes, you can create a label to dispatch part of an order, and then fulfill the rest of the items at a later date.
For more information, see our guide: [Labels for partial shipments](/articles/printing-labels-packing-slips/labels/labels-for-partial-shipments).
How do I generate Australia Post label sheets?
See [Print Australia Post label sheets](/articles/couriers/australia-post/how-to-print-australia-post-shipping-labels-4-per-page).
---
# Printing setup FAQs
URL: https://support.starshipit.com/articles/8412386619151-printing-setup-faqs
Canonical: https://support.starshipit.com/articles/8412386619151-printing-setup-faqs
Markdown: https://support.starshipit.com/articles/8412386619151-printing-setup-faqs.md
Updated: 2026-09-03
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Understand print routing, Desktop App mappings, device printing, and common printer setup questions.
Find quick answers about how Starshipit sends labels and documents to computers, devices, and physical printers.
For the complete setup model, see [Understand how Starshipit printing works](/articles/90200000000155-understand-how-starshipit-printing-works).
What is the difference between Starshipit print settings and Desktop App print settings?
Starshipit website print settings choose which connected Desktop App computer receives a routed label or document. Print settings inside the Desktop App choose the physical printer, paper size, orientation, or PDF destination used by that computer.
Can labels triggered from different Starshipit products use the same Desktop App?
Supported Starshipit web, workflow, WMS, and mobile print actions can create labels. Whether they can use a Desktop App route depends on the product and its selected output method. Configure the receiving machine in Starshipit for routed printing, then configure that machine's physical printer in the Desktop App.
Device-local printing, such as AirPrint, bypasses the Desktop App route.
Do I need the Desktop App to print a label?
No. You can download a label PDF and print it manually, use a browser or system print dialogue where supported, or print from a supported mobile device. Use the Desktop App when you want Starshipit to route jobs automatically to a packing-station computer and its configured printer.
How do I print from multiple computers?
Connect each Desktop App computer with a unique, recognisable machine name. In Starshipit **Settings > Printing > Advanced**, assign each label or document type to the computer that should receive it. In the Desktop App on each computer, map that content to a physical printer.
Do I need to configure a network printer on every computer?
Every computer that may print to the network printer must be able to use it through the operating system. Each Desktop App computer also keeps its own local document and label routes, so select the network printer in the Desktop App on every receiving computer that should use it.
Why did the label reach the right computer but print from the wrong printer?
The Starshipit machine route is working, but the local Desktop App route is not the one you expected. Open **Print Settings** in the Desktop App on that computer and check the affected document default or shipping-label-type route.
What should I do if a tracking number exists but no label printed?
Label creation succeeded. Fix the output route or printer problem, then use **Reprint** to send another copy of the existing label. Do not create another shipment just to retry physical printing.
Where do I change label size and orientation?
First choose a supported label format in the relevant courier or Starshipit settings. For Desktop App printing, set the matching paper size and orientation on the local document or shipping-label route. The operating-system printer preferences and loaded label stock must use the same size.
Why are packing slips printing double-sided?
Double-sided printing is normally controlled by the physical printer's operating-system preferences. Change the printer default from duplex to single-sided, then check that the packing-slip route in the Desktop App uses that printer configuration.
Why is a label blurry or its barcode difficult to scan?
Confirm the label is not being scaled, the printer uses the correct media and resolution, and the print head is clean. For thermal printers, also check the darkness and speed settings recommended by the printer manufacturer.
---
# Manifest orders
URL: https://support.starshipit.com/articles/360001233636-manifest-orders
Canonical: https://support.starshipit.com/articles/360001233636-manifest-orders
Markdown: https://support.starshipit.com/articles/360001233636-manifest-orders.md
Updated: 2026-05-07
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Learn how to manifest orders after generating shipping labels.
Starshipit's manifest function ensures seamless fulfilment by sending order information to your courier directly from your account. Manifests are a key part of the courier billing process when required.
{{video:youtube:Ac3oX_FXWuo}}
## How it works
When you print a label in Starshipit, the order moves to the Printed tab. Manifesting orders is an important step as failure to do so can result in fees from your courier. Not all couriers require manifesting. To check whether a courier requires manifesting, refer to the [Manifesting FAQ](/articles/orders-manifests-reports/faqs/manifesting-faq).
If you use Australia Post eParcel or Parcel Send, see [Manifest Australia Post eParcel orders](/articles/couriers/australia-post/manifest-australia-post-eparcel-orders) for the carrier-specific workflow.
Starshipit features several options for manifesting, which we've covered below.
### Auto manifest orders
You can set Starshipit to manifest your orders automatically. Choose one, multiple, or all your couriers to include in the auto manifest process. This is fully compatible with all couriers supported by Starshipit.
1. Go to **Settings** > **Couriers** in your Starshipit account.
2. Select the couriers you want to include.
3. Enable the option to auto-manifest for child accounts (if applicable).
4. Click **Save** to activate Auto Manifest.
:::note
- By default, auto-manifest runs overnight, typically around 1am NZT. You can optionally choose a time for your manifest to run from the dropdown. This time is based on your local time.
- Auto-manifest will apply to any orders in your printed tab, not archived or already manifested orders.
- We recommend checking printed orders for any errors which may occur.
- Auto-manifest submits eligible shipments to the courier. It does not automatically print a paper manifest copy. If your driver or drop-off point needs a paper copy, download and print the manifest report from the **Manifest** page.
:::
### Manifest select orders
1. In Starshipit, navigate to **Orders** > **Printed** tab.
2. Select the orders you'd like to manifest using the checkbox column.
3. Click on **Manifest orders** in the top menu.
4. Click on **Manifest**.
### Manifest all orders
1. In Starshipit, navigate to **Orders** > **Printed** tab.
2. Click on **Manifest all** on the top right.
3. Click on **Manifest**.
### Use the Manifest page
Choose between dispatching specific shipments or dispatching all shipments for a selected carrier using the Manifest page.
1. In Starshipit, navigate to **Manifest**.
2. Click **New Manifest**.
3. Under Dispatch shipments, copy either your tracking numbers or order numbers into the field.
4. Click **Dispatch Shipments**.
:::tip
Use **Dispatch all** to select a carrier to dispatch all shipments currently awaiting dispatch.
:::
### Download manifest report
1. In Starshipit, navigate to **Manifest**.
2. In the **Downloads** column, click on **Report** to download the file.
If you have any questions about manifesting, check out the [Manifesting FAQ](/articles/orders-manifests-reports/faqs/manifesting-faq).
## Troubleshooting
**My carrier says my shipments weren't manifested, but I can't find them in the Shipped tab. What happened?**
In Starshipit, orders may be moved to the Archived tab after being shipped without being properly manifested. This often occurs when orders are printed but not included in a manifest sent to your courier.
**Why this happens:**
Starshipit moves orders to the Archived tab after they are shipped. However, if these shipments weren't included in a manifest, your carrier won't recognise them as fulfilled. Without the manifest, the carrier may assume the shipments were not processed correctly, resulting in additional charges or fees.
**Solution:**
Double-check the Archived tab or search for the order using the tracking number to locate these shipments. If the order has been archived, you'll need to restore the order before manifesting it. Ensure that all printed orders are manifested before shipping.
---
# Book a courier pickup
URL: https://support.starshipit.com/articles/360000133996-book-a-courier-pickup
Canonical: https://support.starshipit.com/articles/360000133996-book-a-courier-pickup
Markdown: https://support.starshipit.com/articles/360000133996-book-a-courier-pickup.md
Updated: 2026-07-21
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Learn how to book a courier pickup from within Starshipit.
## Supported couriers
You can book a courier pickup from within Starshipit for the following couriers:
* **DHL Express**
* **Couriers Please**
Couriers Please will book a courier pickup on manifest unless you specifically request them not to. You can also book a pickup through Starshipit.
* **Allied Express**
A pickup is automatically booked for the same day when you print an Allied Express label.
* **TNT**
* **Startrack**
* **Border Express**
* **TGE IPEC & TGE Priority**:** Note:** If you encounter an error about account validity, please contact your TGE account manager or reach out directly to etrade@teamglobalexp.com to have your TGE account added to the MyTeamGE Group ID StarShipIT.
* **UPS**
Please ensure you are using the 'New UPS' integration. Booking pickups is not supported on the Legacy UPS API.
* **Aramex**
When booking a pickup with Aramex, you do not need to set your pickup address. The address set in your Aramex account is set as the pickup address. The pickup will be booked for the next available time with Aramex.
* **Post Haste**
* **NZ Couriers**
* **Castle Parcels**
* **NorthLine**
* **FedEx**
FedEx Express pickups can only be scheduled for same day or next day pickup. FedEx Ground pickups are not currently supported.
* **MyPost Business**
MyPost Business has two methods for booking pickups. For more information on this, [read this article.](/articles/couriers/australia-post/mypost-business-integration-faqs)
## Requirements
Please make sure you have the following information before booking the pickup:
* Number of packages
* Total weight of packages (kg)
* Items (required for some couriers)
## Book a pickup
1. Go to the **New orders** screen.
2. Click **Actions** > **Order Pickup** (in the top right).
3. Select the carrier you would like to book the pickup for.
4. Fill in the pickup date, time and pickup details.
5. Click **Order**.
#### From the Printed or Shipped tab
1. Go to the **Printed** or **Shipped** tab.
2. Select the order, then select **Book pickup**.
3. Fill in the pickup date, time and other pickup details.
#### From the Pickups page
1. Go to the **Pickups** page.
2. Click **Book pickup**.
3. Fill in the pickup date, time and other pickup details.
4. Click **Book pickup**.
---
# Manifesting FAQs
URL: https://support.starshipit.com/articles/360001997955-manifesting-faqs
Canonical: https://support.starshipit.com/articles/360001997955-manifesting-faqs
Markdown: https://support.starshipit.com/articles/360001997955-manifesting-faqs.md
Updated: 2026-05-07
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Find answers to frequently asked questions about manifesting.
What is a manifest?
A manifest is a summary of all your shipments either in a paper or electronic format which allows your courier to correctly bill you and accept your freight into their network. The summary will contain information such as the pickup location, receiver location, weight, dimensions and service.
As manifests are used to calculate how much you need to pay for each shipment it is important to ensure you manifest each shipment where required.
How does manifesting work on Starshipit?
Starshipit will submit your manifests electronically and return a paper copy to you. Some courier drivers and drop-off locations may request the paper copy even though the courier would have received the electronic copy from Starshipit. If you lose track of any manifest paper copies you can re-download them in the **Manifests** section under the **Main Menu**.
How do I submit a manifest?
See the [manifest your orders](/articles/orders-manifests-reports/orders/how-to-fulfil-orders#manifest-section) section of our fulfil orders for steps on how to submit a manifest.
Can Starshipit automatically print my manifest?
No. Auto-manifest submits eligible shipments to the courier, but it does not automatically print a paper manifest copy.
If your driver or drop-off point needs a paper copy, go to the **Manifest** page and download the manifest report after the manifest has been created.
Do I need to submit a manifest for every courier?
No, you don't need to submit a manifest for every courier, however, it is very important you do submit a manifest for the couriers who require manifests. Our table below details the requirements of each courier, and the point when they will bill you:
| | | |
| --- | --- | --- |
| **Courier** | **Manifesting Required** | **Point When Billed** |
| Allied Express | No | Label print |
| Australia Post eParcel | **Yes** | Manifest |
| Australia Post MyPost Business | **No^** | Print^ |
| Australia Post On Demand | **Yes** | Manifest |
| Bascik | No | Label print |
| Border Express | No | Label print |
| CourierPost | No | First scan |
| CouriersPlease | **Yes** | Manifest |
| Deutsche Post International | **Yes** | Manifest |
| DHL eCommerce Asia Pacific | **Yes** | Manifest |
| DHL Express | No | First scan |
| DHL Parcel Europe | No | On label print or first scan* |
| DHL Parcel UK | No | On label print or first scan* |
| Direct Freight | Yes | Manifest |
| DPD Local UK | No | First scan |
| DPD NL | No | On label print or first scan* |
| DPD UK | No | On label print or first scan* |
| Fastway FastLabel | No | On label print or first scan** |
| Fastway MyFastway | No | On label print or first scan** |
| FedEx | No | Print |
| Hermes | No | First scan |
| Hunter Express | No | Label print |
| NZ Couriers | No | On label print or first scan* |
| NZ Post | No | First scan |
| Pace | No | First scan |
| Pickup In Store | No | N/A |
| Plain Label | No | N/A |
| Quantium Solutions AU | Yes | Manifest |
| Quantium Solutions NZ | Yes | Manifest |
| Royal Mail | Yes | Manifest |
| Sherpa | No | Print |
| Seko Logistics | Yes | Print |
| Sendle | No | Print |
| Singapore Post | Yes | Manifest |
| StarTrack | Yes | Manifest |
| TNT Australia | No | Print |
| Team Global Express IPEC | Yes | Manifest |
| Team Global Express Priority | Yes | Manifest |
| USPS | No | Label print |
| UPS | No | Print |
| Zoom2u | No | Print |
| Freightways | No | Print |
* Check with the courier.
** Depends on Fastway account type, on print by default.
^ Credit card accounts only.
---
# Use shipping analytics
URL: https://support.starshipit.com/articles/6269438607887-use-shipping-analytics
Canonical: https://support.starshipit.com/articles/6269438607887-use-shipping-analytics
Markdown: https://support.starshipit.com/articles/6269438607887-use-shipping-analytics.md
Updated: 2026-06-15
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Use shipping analytics to review order volume, carrier performance, delivery timing, and fulfilment trends.
Use shipping analytics to review order volume, compare carrier performance, and identify whether shipments are being delivered early, on time, or late.
:::note
Multi-workstation accounts do not have access to shipping analytics.
:::
## Before you begin
Shipping analytics uses data from orders and shipments in your Starshipit account. Some dashboard filters or charts may not show options until matching shipment data exists.
Shipping performance is supported for:
- StarTrack
- eParcel
- MyPost Business
- DHL Express
- Team Global Express
## Watch the overview
Use the video that matches your Starshipit interface.
## Use shipping analytics
Use shipping analytics to:
- Identify why carrier performance is above or below target.
- Compare carriers or services on the same route.
- Review fulfilment and transit trends over time.
- Export or reuse performance data in reporting tools such as Power BI.
Shipping analytics has two dashboards: **Shipping summary** and **Shipping performance**.
## Review shipping summary
The **Shipping summary** dashboard shows order volume split by platform and carrier. Use the date range filter at the top of the page to control the reporting period.
The dashboard includes these views:
| View | Shows |
| --- | --- |
| **Orders** | Total number of orders created. |
| **Order status** | Total number of unshipped, printed, and shipped orders. |
| **Order status by platform** | Unshipped, printed, and shipped orders grouped by platform. |
| **Order status by carrier** | Unshipped, printed, and shipped orders grouped by carrier. |
| **Unshipped vs shipped by day** | Daily comparison of unshipped and shipped orders. |
| **Order status by child account** | Order status for multi-location, 3PL, and full-access child accounts. |
## Review shipping performance
The **Shipping performance** dashboard helps you check whether carrier services are meeting delivery KPIs. For example, you can see whether orders are being delivered early, on time, or late.
Use the filters at the top of the page to segment dashboard data. The filter choices apply to every visual on the dashboard.
| Filter | Use it to |
| --- | --- |
| **Domestic/international** | View domestic or international shipments. |
| **Date range** | Filter shipments created between selected dates or a preset period, such as the last 30 days. |
| **Carrier** | Compare multiple carriers or focus on one carrier. |
| **Shipping Method** | Compare services such as overnight, express, or other configured methods. |
:::note
If there are no matching data points, the filter bar will not return filter options.
:::
## Understand shipping performance metrics
| Metric or chart | What it tells you |
| --- | --- |
| **KPI gauges** | The percentage of shipments delivered early, on time, or late according to carrier data. |
| **Score cards** | Shipment volume for the selected filters and how that volume is split across key metrics. |
| **Delivered status** | How many shipments were delivered early, on time, or late. |
| **Average handling time** | Average warehouse processing time, average transit time, and total fulfilment time. |
| **Delivered status breakdown** | Delivery performance across a selected time span, helping you spot dates or volume spikes linked to missed KPIs. |
| **Average handling time breakdown** | Warehouse and transit time trends across a selected time range. |
| **Carrier performance analysis** | A heatmap comparing carriers by total shipments, average transit time, early deliveries, on-time deliveries, late deliveries, and average late time. |
Average handling time appears in hours when the average is less than 24 hours, and in days when the average is more than 24 hours.
## Verify your analysis
After changing filters, check that the dashboard visuals update to match the selected carrier, service, date range, and domestic or international setting. If a chart has no data, widen the date range or remove filters to confirm whether matching shipments exist.
## Related articles
- [Generating reports](/articles/360000383635-generating-reports)
- [Scheduled reporting](/articles/6930762037263-scheduled-reporting)
- [View the quoted shipping cost for orders](/articles/4404304727695-view-the-quoted-shipping-cost-for-orders)
---
# Generate reports
URL: https://support.starshipit.com/articles/360000383635-generate-reports
Canonical: https://support.starshipit.com/articles/360000383635-generate-reports
Markdown: https://support.starshipit.com/articles/360000383635-generate-reports.md
Updated: 2026-02-11
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Learn how to generate reports in Starshipit to track packages, shipped items, and more.
Starshipit offers seven types of reports: Packages Sent, Shipped Items, Unshipped Packing Summary, Shipments Per Workstation, Unshipped Orders, Shipping Price, and Delivery Performance. See [Frequently asked questions](#h_01HZJTPJE30YB303CGBPM8MM93) for more information.
## Types of reports
**Package Sent Report**contains all packages with their tracking numbers sent within your selected time frame. It lists each package individually, including details such as item SKUs, incoterms, order value, number of packages and package names. This can be useful for tracking all sent packages and identifying shipments created in the Returns Portal.
---
**Shipped Items Report**generates a report of every sent item, listing each item individually. This report includes item SKUs, quantity shipped, manifest number and tracking number. This can be useful for stock management to see what has been sold in a set time period.
---
**Unshipped Packing Summary Report**contains all the items and quantities that need to be packed and shipped. This can be useful for identifying the quantities of each SKU to bulk pick for the orders selected.
---
**Shipments Per Workstation Report**displays all the shipments processed per workstation. This can be useful for monitoring and managing the efficiency of different workstations in the shipping process.
---
**Unshipped Orders Report** includes details of all unshipped orders on your account. This includes SKUs, order totals and customer details across all order sources. This is useful in identifying and managing unshipped orders and ensuring they're processed in a timely manner. It can also be used to cross-check information across different sources to verify accuracy.
---
**Shipping Price Report** generates a report with pivot tables and charts of your shipping performance.
By analysing the report, you can:
* Identify trends and patterns in your shipping expenses.
* Compare costs across different carriers and shipping methods to find cost-saving opportunities.
* Use the insights from the report to negotiate better rates with carriers.
* Adjust your shipping strategies based on the cost analysis to improve efficiency and reduce expenses.
---
**Delivery Performance Report** generates pivot tables and charts that analyse carrier delivery performance.
By analysing the report, you can:
* Identify trends and highlight areas for improvement in delivery times, such as early, on-time or late deliveries.
* Identify if your carriers are meeting key delivery KPIs.
* Use it to support more informed discussions with your carriers about their performance.
## Generate a report
1. In Starshipit, navigate to **Reports**.
2. Click on **Generate Report**.
3. Select the [type of report](#h_01K0X6BZGHY886KMH6N82WDN4S) you want to generate.
4. Set the start and end dates for the report.
5. Click **Generate**.
The report is added to the report queue. Once it has been generated, the report status will change from **Pending** to **Ready**.
6. Click **Download** to download it as a CSV file.
:::warning
When setting the date range for the report, the start date cannot be more than 1 year from today and the end date cannot be more than 6 months from today.
:::
## FAQs
I want to pull a report for 12/24 months of data but I'm getting an invalid parameter(s) error
When setting the date range for the report, the start date cannot be more than 1 year from today and the end date cannot be more than 6 months from today.
If I have multiple packages for the same order, will I see them in one row?
There will be one row for each package, so there can be multiple rows for the same order number.
Does the Package Sent Report include shipments created in the Returns Portal?
Yes, you can identify these shipments by checking column AJ (Return Label) for the value 'Yes'.
What does x column mean in the Package Sent Report?
| Column Title | Description |
| --- | --- |
| Price | This represents the quoted price on which the label was printed. |
| Freight Charge | This refers to the shipping paid on checkout |
---
# Schedule reports
URL: https://support.starshipit.com/articles/6930762037263-schedule-reports
Canonical: https://support.starshipit.com/articles/6930762037263-schedule-reports
Markdown: https://support.starshipit.com/articles/6930762037263-schedule-reports.md
Updated: 2026-05-07
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Learn how to automate reports to be sent directly to your email daily or weekly.
Automating your reports to be sent directly to your email daily, weekly, or monthly saves time, provides timely insights, and makes it easier to distribute insights to relevant parties. Learn more about the types of reports you can generate in [Generating Reports](/articles/orders-manifests-reports/reports/generating-reports).
## Set up scheduled reporting
1. In Starshipit, navigate to the **Reports** section.
2. From the top right of the screen, select the **Schedule Report** option.
3. Tick the checkbox beside each report you would like to receive.
4. Specify up to three emails to receive the reports in the **Receivers** field. Separate each email with a comma.
5. Select the frequency for your reports (daily, weekly, or monthly).
6. Choose whether you want to include child accounts and archived orders in your report.
7. Click **Save**.
## FAQs
When are the reports sent?
The daily report is sent at 7pm UTC, the weekly report is sent 7pm Sunday UTC, and monthly reports are sent on the 1st of each calendar month.
How do I disable the reports?
To disable the reports, you can either untick the report option or remove your email from the list of recipients.
I want to send the reports to more than three recipients.
You can set up one of the email addresses to automatically forward the reports to any additional recipients from your email software:
- [Gmail: Automatic Forwarding](https://support.google.com/mail/answer/10957)
- [Outlook: Automatic Forwarding](https://support.microsoft.com/en-us/office/turn-on-automatic-forwarding-in-outlook-7f2670a1-7fff-4475-8a3c-5822d63b0c8e)
If I have multiple accounts, how can I tell the scheduled reports apart?
The account number is included in both the report's subject line and the downloaded file name. For example:
- **Subject line**: Starshipit [Acct12345] Unshipped packing summary
- **File name**: UnshippedPackingSummary_Acct12345.csv
---
# Reconcile shipping invoices
URL: https://support.starshipit.com/articles/11469376267151-reconcile-shipping-invoices
Canonical: https://support.starshipit.com/articles/11469376267151-reconcile-shipping-invoices
Markdown: https://support.starshipit.com/articles/11469376267151-reconcile-shipping-invoices.md
Updated: 2026-02-09
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Learn how to use Invoice Reconciliation to compare courier invoices with Starshipit shipping costs.
The Invoice Reconciliation feature simplifies invoice checking by allowing you to upload courier invoices directly into Starshipit. It compares the shipping costs quoted by Starshipit with those charged by your courier, quickly highlighting any discrepancies. Starshipit supports all couriers and CSV invoice formats, provided your file contains a tracking number.
:::note
Currently only supported in Classic UI.
:::
## Benefits
| Benefit | Description |
|---------|-------------|
| Time-saving | Automates the reconciliation process, reducing manual effort |
| Accuracy | Provides a clear breakdown of discrepancies between quoted and invoiced shipping prices |
| Transparency | Enhances cost management by offering detailed insights into shipping costs |
## How it works
### 1. Upload your invoice
1. In Classic UI, navigate to **Analytics** > **Reports** > then select the **Invoice Reconciliation** section.
2. Upload your courier invoice in CSV format.
3. In the **Tracking Number Column** field, enter the exact column name from your CSV file that contains tracking numbers (case-sensitive).
4. (Optional) Tick **Include Child Accounts** if you manage multiple accounts and want to include their orders in the reconciliation.
### 2. Matching and report generation
Starshipit matches each tracking number from your uploaded invoice with orders in your Starshipit account.
When a match is found, Starshipit generates a new report based on your original invoice, appending additional details:
| Field | Description |
|-------|-------------|
| SSI_ConsignmentId | Unique shipment ID from Starshipit |
| SSI_AccountId | Starshipit account ID associated with the shipment |
| SSI_AccountName | Name of the Starshipit account associated with the shipment |
| SSI_Weight | Weight of the shipment declared in Starshipit |
| SSI_Dimensions | Dimensions of the shipments declared in Starshipit |
| SSI_ShippingPricePaid | The price paid for shipping on checkout |
| SSI_EstimatedShippingPrice | The estimated quoted shipping price from the carrier API when you printed the order in Starshipit |
| SSI_Margin | Any margin set in Starshipit through Customise Rates settings |
| SSI_Discrepancy | Difference between the price paid for shipping at checkout and the estimated shipping cost |
## FAQs
What invoice formats does Starshipit support?
Starshipit supports CSV formats from all couriers, as long as the file includes a tracking number column.
How does Starshipit match invoice data to orders?
Starshipit uses the tracking numbers from your CSV invoice to find matching orders within your account.
What happens if my tracking number column name isn't found?
Ensure the column name you entered matches exactly (case-sensitive). If Starshipit can't find it, the report won't generate, and you'll see an error.
What if some tracking numbers don't match orders in my account?
The report will still generate, but unmatched entries will leave Starshipit-specific fields blank.
---
# Prepare Starshipit for peak season
URL: https://support.starshipit.com/articles/11230658291855-prepare-starshipit-for-peak-season
Canonical: https://support.starshipit.com/articles/11230658291855-prepare-starshipit-for-peak-season
Markdown: https://support.starshipit.com/articles/11230658291855-prepare-starshipit-for-peak-season.md
Updated: 2026-05-06
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Prepare your Starshipit workflow, carriers, and team for peak shipping periods.
Prepare your Starshipit account for peak season with these optimization strategies. From auto-assigning the cheapest carrier to reducing packaging waste, these tips will help your dispatch team handle increased order volume efficiently.
## Auto-assign the cheapest carrier
Did you know you can create rules based on the cheapest shipping option in Starshipit? This means when orders are imported, they're automatically assigned to the cheapest courier - either every time or based on conditions you set.
This rule makes it simple for your dispatch team to print labels without having to check the cheapest option has been selected.
**How to get started:**
* Head to Settings > Rules.
* Select 'Add a new rule'.
* Under Condition(s) select the order type that's relevant to you (e.g. All Orders).
* Under Action choose 'Select Cheapest Carrier/Service'.
* Click Save.
[Read the guide](/articles/notifications-branded-tracking-rules-child-accounts/business-rules/create-a-rule-based-on-cheapest-delivery-option?utm_campaign=countdown_to_peak&utm_source=hs_email&utm_medium=email&_hsenc=p2ANqtz-9Ggmdsqz85ay33Yda47dANHjajpCRYEC2QIBcy2fOY_1Nkb8zohWhKcSgZStvZHKXypiN7)
## Add SKUs to labels and skip the packing slip
When you print SKUs directly on your shipping labels, you can fulfill your orders more efficiently, without the need for separate packing slips. The best part? You’ll save time – and paper!
**Here’s how it works:**
* Go to 'Settings' > 'Couriers' > [Courier Name] > 'Advanced'
* Tick 'Enable SKUs on labels'
* All your new orders will include the SKU on the label to help you pick and pack!
* SKUs on labels is only supported for Australia Post, DHL, Border Express, Seko, MyFastway, Couriers Please, MyToll and plain labels.
## Use recommended packaging to reduce packaging waste and save money
Using an intelligent algorithm, this feature matches the dimensions of items within an order with your configured packages, automatically selecting the best size package every time. This not only minimises material waste but also helps you save on shipping costs.
Here's how to set up recommended packaging:
* Ensure you have set up your packages with the correct dimensions in your Starshipit account.
* Confirm that your product imports include item dimensions. The most efficient method is through the Product Catalogue.
* Go to 'Settings' > 'Packaging' > 'Weight of Packaging' in your Starshipit account. Choose 'Automatically assign packages based on item dimensions' from the dropdown menu.
[Read the guide](/articles/getting-started/how-to-guides/how-to-assign-packages-automatically-based-on-item-dimensions-recommended-packaging?_hsenc=p2ANqtz-_iGmWwy-1C3c0BQb0bK7b3leP0hPHsoHZOqGx6pFrcDI4H3drPZlynEW29G0db20XhIfzf&utm_campaign=countdown_to_peak&utm_medium=email&utm_source=hs_email)
## Merge orders to save time and money (UI 2.0)
Peak season often means customers making multiple purchases in a short space of time, typically due to upsell opportunities and sales. Merging orders lets you cut down processing time and save on shipping costs.
The best part? Starshipit can suggest merges for you automatically!
**Here’s how to merge orders:**
* Click Suggested Merges in the main orders grid.
* Starshipit will display any orders that share a common destination, indicating they can be merged.
* To merge a group, simply select the orders in the same row group and select Merge on the right-hand side.
* In the pop-up dialog, assign a parent order, and click Merge. The orders are now merged!
**If you have multiple merge suggestions, you can efficiently bulk merge orders:**
* Select all the groups you wish to merge or use the checkbox in the top left to select all orders.
* Click Merge All.
## Use Starshipit's Chrome Apps to save time and resolve 'Where's my order queries'!
* Starshipit Sidekick: Save time by seamlessly printing labels and bringing up order details directly in your eCommerce platform/OMS/WMS, without the need to switch screens.
* Starshipit Order Tracker: Instantly resolve 'Where's my order?' queries. Empower your customer-facing staff with seamless access to order delivery status, enabling better customer experiences.
**How to get started:**
* You can install both of our extensions using Google Chrome or Microsoft Edge.
* Head over to the [Starshipit Chrome Apps page](https://starshipit.com/chrome-apps?utm_campaign=countdown_to_peak&utm_source=hs_email&utm_medium=email&_hsenc=p2ANqtz-9IFyLommJJdDEL_pX6OGInGr09OTYcBFc1439kdgpPk0h8Cb2ktA6vm3BZ3H4lAT16xJQG) to follow our easy step-by-step guides, watch the videos and more.
## Bulk auto-correct addresses
Want to save time and reduce delivery errors? Try Starshipit's bulk auto-correct feature. With just a few clicks, you can automatically validate and correct multiple addresses at once, ensuring your packages reach their intended destinations.
Here's how to bulk auto-correct your addresses, in both our Classic UI and UI 2.0:
* From the Orders screen, to filter invalid orders, click either:
+ Check addresses (UI 2.0)
+ Invalid only (Classic UI)
* Once you see a list of the invalid orders, click:
+ Update (UI 2.0)
+ Auto correct (Classic UI)
* You're done!
[Read the guide](/articles/orders-manifests-reports/orders/validating-shipping-addresses?utm_campaign=countdown_to_peak&utm_source=hs_email&utm_medium=email&_hsenc=p2ANqtz-81wPeZqgs0gDNfg5wjFInCt-YKGTW8RZwLfIyxauwlBej7L-nAd0Po3kIzjY58ZjVog8M2)
---
# Understand live rates at checkout and supported couriers
URL: https://support.starshipit.com/articles/360000973695-understand-live-rates-at-checkout-and-supported-couriers
Canonical: https://support.starshipit.com/articles/360000973695-understand-live-rates-at-checkout-and-supported-couriers
Markdown: https://support.starshipit.com/articles/360000973695-understand-live-rates-at-checkout-and-supported-couriers.md
Updated: 2026-09-14
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Learn about live rates at checkout and which couriers are supported for real-time shipping quotes.
{{video:youtube:fmSmi2ndu4M}}
## Supported couriers
Allied Express
Australia Post eParcel
Australia Post MyPost Business
Border Express
Castle Parcels
NZ Post Domestic
CouriersPlease
DHL Express
Deliver in Person
Direct Freight
Aramex (formerly Fastway)
FedEx
Hunter Express
NZ Couriers
NZ Post
Post Haste
Rendr
Sherpa
StarTrack
TNT
Team Global Express IPEC
Team Global Express Priority
Uber
UPS
USPS
Zoom2u
Mainfreight2Home
Flash Couriers
Aramex live rates are available when your account uses MyFastway and has the Quote v2 endpoint enabled. Available rates still depend on your connected carrier account, service, and checkout-rate configuration.
## How it works
Starshipit will return your contract rates at checkout, which is the pricing you have negotiated with your courier company. The courier company electronically provides these prices to Starshipit.
The rates that are displayed on checkout and when they are displayed are fully customisable.
Live rates at checkout are available for the following platforms and couriers:
## eCommerce
* [Shopify (Shopify Advanced or Shopify Plus)](/articles/rates-at-checkout/platform-specific-guides/shopify-rates-at-checkout)
* [Magento](/articles/rates-at-checkout/platform-specific-guides/magento-1-rates-at-checkout)
* [Adobe Commerce](/articles/rates-at-checkout/platform-specific-guides/adobe-commerce-rates-at-checkout)
* [PrestaShop](/articles/rates-at-checkout/platform-specific-guides/prestashop-rates-at-checkout-dhl-express-only) Please note that **DHL** is the only carrier that pulls live rates.
* [WooCommerce](/articles/rates-at-checkout/platform-specific-guides/woocommerce-rates-at-checkout)
* [BigCommerce](/articles/rates-at-checkout/platform-specific-guides/bigcommerce-rates-at-checkout)
* [Wix](/articles/rates-at-checkout/platform-specific-guides/wix-rates-at-checkout)
## **What's Next?**
[Set up live rates at checkout](/articles/rates-at-checkout/set-up-guides/set-up-rates-at-checkout).
---
# Set up rates at checkout
URL: https://support.starshipit.com/articles/360000179036-set-up-rates-at-checkout
Canonical: https://support.starshipit.com/articles/360000179036-set-up-rates-at-checkout
Markdown: https://support.starshipit.com/articles/360000179036-set-up-rates-at-checkout.md
Updated: 2026-03-18
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Step-by-step guide to setting up rates at checkout.
{{video:youtube:fmSmi2ndu4M}}
## How it works
* By default, rates at checkout will be based on the weight, package dimensions where available, and destination of the cart.
* You can use our checkout rules engine to further configure your checkout rates settings. For example, you could set up rules to automatically cover your shipping surcharges, apply free shipping, or assign specific couriers to orders that contain dangerous goods.
* Starshipit supports rates at checkout whether it's the exact rate provided by the courier (live rate), or a rate that you determine (table rate).
## Configuring rates at checkout
1. Go to **Settings**\> **Checkout Rates**\> **Settings**.
2. From the Weight and Dimensions section, select how you would like your rates to be calculated:
* **Single Package using sum of integration item weights:** The rate will be based on the total weight of all the items in the cart being sent in a single package .
* **Single Package using sum of integration item weights and dimensions:**
The rate will be based on a singular package with the added dimensions and weight of all items in the cart.
*Direct integration item dimensions are only supported for WooCommerce, Magento 1 and Magento 2.*
* **Single Package using default package weight and default dimensions**
The rate will use the weight and dimensions of the package you have selected as your default.
* **Unique Package for each item using integration item weight and item dimensions:**
The rate will be calculated with one package per item in the cart using both the item’s weight and dimensions. *Direct integration item dimensions are only supported for WooCommerce and Magento 2.*
3. Click **Save.**
*These rates will now be available on checkout.*
:::note
Shopify sends cart weight, not item dimensions, in checkout-rate requests. To use item dimensions for Shopify rates, add matching SKU dimensions to the [Product Catalogue](/articles/integrations/product-catalogue/product-catalogue) and enable **Use on checkout** in **Settings > Product Catalogue**. This Product Catalogue path is separate from the direct integration item-dimension options above.
:::
## **How to add a new product & service**
1. Navigate to **Settings** \> **Checkout Rates**.
2. Navigate to the **Courier Configuration** tab.
3. Click **Add New Shipping Option**.
4. Select the Carrier & Product.
5. (Optional) **Display Name**
* By default, when left empty, Starshipit uses the carrier’s service name (e.g., DHL Express Shipping).
* However, if required, you can rename it to something more user-friendly (e.g., Express Shipping).
6. (Optional) **Margin**
* Margins allow you to adjust the final shipping rate displayed to customers.
* You can increase the rate (e.g., adding a handling fee) or decrease it (e.g., offering a discount).
* Two margin types:
* Flat Fee: Adds or subtracts a fixed amount (e.g., contract rate + $5.00).
* Percentage: Adjusts the price by a percentage (e.g., contract rate + 5%).
* This is useful for businesses looking to offset costs, apply handling fees, or offer competitive shipping rates.
7. (Optional) **Estimated Transit Time**
* The estimated transit time provides an expected delivery timeframe for shipments using this service.
* For DHL and Australia Post, transit times can be retrieved dynamically.
* For other couriers, you can manually set transit times.
8. (Optional) **Display Start & End Time**
* Display Time lets you control the visibility of shipping options based on time constraints.
* Example: If your courier has a cutoff time, you can hide same-day delivery after 1 PM.
9. (Optional) **Group**
* What is a Group?Group allow you to categorise similar shipping services from different carriers, helping to identify and organise them for a better user experience at checkout.
* Why use a Group?
* If multiple couriers offer the same type of service (e.g., express shipping), grouping ensures they are displayed under a single option.
* Example: Instead of showing DHL Express and FedEx Priority separately, they can be grouped as Express Shipping.
* This helps customers compare shipping rates and transit times for similar services from different carriers, making it easier to choose the best option.
* How to use a Group?
* Create a group by selecting "Add new group" in the Checkout Settings page.
* Once created, services can be assigned to a group when adding a new shipping option.
10. Click **Save** to confirm the new shipping option.
## **Enabling fail over rates**
A **Fail Over rate** is a flat rate that you can enable which will be displayed on checkout in the case that the selected carrier does not return a rate for the address. This can be helpful when carriers experience a temporary outage or if the customer enters an invalid address that the courier does not recognise.
1. Go to **Settings**\> **Checkout Rates**\> **Courier Configuration**.
2. Click **Add New Shipping Option**.
3. Select the carrier.
4. In the **Product** dropdown, select **FAIL-OVER** (Domestic or International).
5. Set the Margin Value to determine the fallback rate.
6. Click **Save** to enable the failover rate.
## **Set up table rates**
Table rate shipping allows you to manually set shipping costs based on the location and weight of an order, which you can display at checkout instead of real-time carrier rates.
It also provides the flexibility to choose between real-time carrier rates or table rates, determined by factors such as destination, weight, order value, or the number of items in an order through customisable checkout [rules engine](/articles/rates-at-checkout/set-up-guides/rules-for-checkout-rates).
This helps you offer competitive and predictable shipping prices, enhancing the customer experience with clear, reliable, and cost-effective shipping options.
1. Navigate to **Settings** \> **Checkout Rates** \> **Courier Configuration**.
2. Click **Add New Shipping Option**.
3. Select **Flat Rate** under the **Select Carrier** dropdown menu.
4. Configure Table Rates:
* Starshipit allows you to set rates in a matrix format based on location & weight.
* Click [here](/articles/rates-at-checkout/set-up-guides/set-up-table-rates) for detailed table rate setup instructions.
5. (Optional) Tick **Set Table Rates as Default** to prioritise table rates over contract rates.
6. Click **Save** to finalise the setup.
## **Testing your Live Rate configuration**
Once you have configured your live rates you may want to test how the rates would display on checkout. Starshipit supplies a Checkout Rates tool where you can check what rates are returned based on a test address and specified item weight. To use this tool:
1. Go to **Settings**\> **Checkout Rates**\> **Tools**.
2. From the toggle, select which eCommerce platform you are using.
3. Enter the Country you would like to test.
4. The rest of the address can be auto-completed when using the Street field.
5. Enter in the Weight of the cart taking note of the unit needed.
6. Click **Get Rates**.
7. You will see what rates are returned based on the criteria provided. From here, you can tweak your configuration as needed.
---
# Set up table rates
URL: https://support.starshipit.com/articles/4414357709071-set-up-table-rates
Canonical: https://support.starshipit.com/articles/4414357709071-set-up-table-rates
Markdown: https://support.starshipit.com/articles/4414357709071-set-up-table-rates.md
Updated: 2026-06-15
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Step-by-step guide to setting up table rates.
## Set up table rates
Table rates for checkout and returns work in the same way. You can configure rates based on location and weight range.
## Table rates at checkout
For example, you are based in Sydney and want to offer a cheaper rate to customers in NSW. The item is large, so you still want the price to increase by weight.
| Location/Rate | 0 to 5kg | 5 to 10kg | 10 to 20kg |
| --- | --- | --- | --- |
| New South Wales | $5 | $10 | $15 |
| Rest of Australia | $20 | $25 | $30 |
1. Go to **Settings** > **Checkout Rates** > **Courier Configuration** > **Table Rates**.
2. Enter the mandatory **Product Code** and **Product Name**.
* **Product Code** is an internal reference value for use with rules in Starshipit.
* **Product Name** is displayed at checkout.
3. Under **Shipping Rates**, enter each rate as `Weight|Price`.
Example shipping rates:
| Value | Meaning |
| --- | --- |
| `5\|5` | Up to 5kg = $5.00 |
| `10\|10` | Over 5kg to 10kg = $10.00 |
| `20\|15` | Over 10kg to 20kg = $15.00 |
## Table rates for the Returns Portal
For example, you want to charge customers for the cost of shipping back a return. You offer both international and domestic returns, but international shipments cost 50% more in shipping.
| Location/Rate | 0 to 5kg | 5 to 10kg | 10 to 20kg |
| --- | --- | --- | --- |
| Australia | $5 | $10 | $15 |
| Rest of World | $7.50 | $15 | $22.50 |
This feature is available as part of the Returns Portal.
1. Go to **Settings** > **Returns** > **Return Charges**.
2. Select the return option you want the charge to apply to.
* Return options are **Store Credit**, **Payment Refund**, and **Exchange Product**.
* You can define different return costs for each return option, or use the same costs for all options.
3. Under **Return Charges**, enter each rate as `Weight|Price`.
Example return rates:
| Value | Meaning |
| --- | --- |
| `5\|5` | Up to 5kg = $5.00 |
| `10\|10` | Over 5kg to 10kg = $10.00 |
| `20\|15` | Over 10kg to 20kg = $15.00 |
## Table rates validation
### Country codes
The **Country Codes** field can be:
* empty, which applies to all country codes
* specific to a list of country codes, such as `AU, NZ`
* used to exclude a list of country codes, such as `!CA`
### State codes
The **State Codes** field can be:
* empty, which applies to all state codes
* specific to a list of state codes, such as `NSW, VIC`
* used to exclude a list of state codes, such as `!WA`
### Postcodes
The **Post Codes** field can be:
* empty, which applies to all postcodes
* specific to a list of postcodes, such as `2000` or `3000`
* specific to a list of postcode ranges, such as `2000-2999` or `3000-3999`
* used to exclude a list of postcodes, such as `!2000` or `!3000`
* used to exclude a list of postcode ranges, such as `!2000-2999` or `!3000-3999`
Use a standard hyphen (`-`) when entering postcode ranges. Do not use an en dash or em dash.
### Shipping rates
The **Shipping Rates** field is mandatory. Enter each rate as `Weight|Price`.
| Value | Meaning |
| --- | --- |
| `5\|6.50` | Up to 5kg = $6.50 |
| `10\|15.00` | Over 5kg to 10kg = $15.00 |
| `20\|22.00` | Over 10kg to 20kg = $22.00 |
## Bulk edit table rates
If your account has the **Bulk editor** option, you can edit many table-rate rows in a spreadsheet and paste them back into Starshipit.
1. Go to **Settings > Checkout Rates** and open the relevant carrier's table rates.
2. Turn on **Bulk editor**.
3. Select **Copy** and paste the rows into a spreadsheet.
4. Update the rows, keeping the columns in the same order.
5. Copy the edited rows from the spreadsheet and paste them into **Bulk editor**.
6. Save the carrier table rates.
The columns are: product code, product name, landed cost service, country codes, state codes, postcodes, suburbs, shipping rates, estimated transit time, display start time, and display end time.
:::important
The bulk editor expects tab-separated rows without a header row. Keep shipping rates in the `Weight|Price` format, such as `5|5` or `10|10`.
:::
## Upload a table rates CSV
Some accounts also have a **Table rates CSV** section in **Settings > Checkout Rates**. If it is available, use **Download CSV** to get the current file, edit a copy, then select **Upload CSV** to replace the account-level table rates.
Download the existing CSV before editing so its column order and carrier names stay valid. Deleting the CSV removes its table rates; carriers that only use that CSV return to contract rates.
---
# Set up free shipping in Starshipit
URL: https://support.starshipit.com/articles/8365565440911-set-up-free-shipping-in-starshipit
Canonical: https://support.starshipit.com/articles/8365565440911-set-up-free-shipping-in-starshipit
Markdown: https://support.starshipit.com/articles/8365565440911-set-up-free-shipping-in-starshipit.md
Updated: 2026-02-11
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Step-by-step guide to setting up free shipping in Starshipit.
## Enable rates at checkout on your eCommerce platform
To get rates from Starshipit (flat or live) to show on your checkout, you'll need to [enable rates at checkout](/articles/rates-at-checkout/set-up-guides/about-live-rates-at-checkout-supported-couriers) on your eCommerce platform first.
## Enable free shipping for orders over a certain value
Display free shipping for orders over a certain value (e.g. $100):
1. Navigate to **Settings** > **Checkout Rates** > **Rules**.
2. Select **Add a new rule**.
3. Select **Condition(s)** > **Order Value** > **Greater Than** > (Enter your order value, for example, $100. Note, that this needs to be entered as 10,000 when using Shopify).
4. Select **Action** > **Set Checkout Rates**.
5. Select **Value** (Choose your courier from the dropdown).
6. Select **Free Shipping**.
7. Click **Return this item only**.
8. Click **Save**.
[Free shipping rule for orders over a certain value](/uploads/attachments/free-shipping-order-value.png)
## Offer free shipping for standard orders over a certain value, but offer live rates for express
1. Ensure you have enabled both the standard and express service from **Settings** > **Advanced Courier Configuration**.
2. Select **Add a new rule**.
3. Select **Condition(s)** > **Order Value** > **Greater Than** > (Enter your order value, for example, $100. Note, this needs to be entered as 10,000 when using Shopify)
4. Select **Action** > **Set Checkout Rates**.
5. Select **Value** (Choose your standard courier from the dropdown).
6. Select **Free Shipping**.
7. Do not tick – **Return this item only**.
8. Click **Save.**
## Offer free shipping for orders over a certain value, and use live rates for orders below this value
If you’d like to offer free shipping for orders over a certain value (e.g. $100), but display live rates for orders below $100, here’s how to set it up:
#### Step 1: Set up live rates at checkout
1. Navigate to **Settings** > **Checkout rates**.
2. Click **Courier Configuration**.
3. Click **Enable advanced setting view**.
4. Click **Contract Rates** next to your courier.
5. Enable the services you’d to display rates for.
6. Change the name, add margins, estimated transit times and any other relevant details.
#### Step 2: Enable free shipping for orders over a certain value
1. Navigate to **Checkout Rates** > **Rules**.
2. Select **Add a new rule**.
3. Select **Condition(s)** > **Order Value** > **Greater Than** > (Enter your order value, for example, $100. Note, this needs to be entered as 10,000).
4. Select **Action** > **Set Checkout Rates**.
5. Select **Value** (Choose your courier from the dropdown).
6. Select **Free Shipping**.
7. Click **Return this item only**.
8. Click **Save**.
---
# Customise courier rates
URL: https://support.starshipit.com/articles/10633684708239-customise-courier-rates
Canonical: https://support.starshipit.com/articles/10633684708239-customise-courier-rates
Markdown: https://support.starshipit.com/articles/10633684708239-customise-courier-rates.md
Updated: 2026-09-14
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Customise carrier rates in Starshipit, including margins, displayed service names, hidden services, and child-account rules.
Customise the courier rates Starshipit returns, including margins, service display names, and rules for child accounts. These settings are separate from setting up live rates at checkout.
:::note
To set up live rates at checkout, follow [Set up rates at checkout](/articles/rates-at-checkout/set-up-guides/set-up-rates-at-checkout).
:::
## Set up a customised rate
To customise your shipping rates:
1. Go to **Settings > Customise Rates**.
2. Select **Add new carrier rates**.
3. Select the **Carrier** and **Product** you want to customise.
4. Enter an optional **Display name**. This changes the name shown for the service, not the carrier name.
5. Select a **Margin type** and enter the **Margin value**:
- **Add Percentage Margin** adds a percentage to the carrier rate.
- **Add Flat Margin Amount** adds a fixed amount to the carrier rate.
- **Set Flat Rate** replaces the rate with the amount you enter.
6. To limit the rule, select **Shipping zone** under **Conditions**, then select a zone.
7. If you manage child accounts, select the accounts under **Apply to child accounts**.
8. Select **Save**.
Starshipit applies the rule automatically when it returns the matching courier rate.
:::note
For example, if a courier rate is $5 and you add a flat margin of $10, the customised rate is $15.
:::
## NZ Post Domestic
NZ Post Domestic has additional controls for pricing base services and surcharges by route sector, add-on, and package. See [Customise NZ Post Domestic rates](/articles/15100000000020-customise-nz-post-domestic-rates) for the detailed setup and verification steps.
## Hiding a courier service
If you wish to hide a specific courier service from being displayed:
1. Navigate to **Settings** \> **Customise Rates** \> Select **Add new carrier rates**.
2. **Select the Service**
Choose the service you want to hide.
3. **Enable the Hide Product Option**
This will prevent the selected service from appearing in the rates list.
## Apply customised rates to your child account(s)
To customise rates for your child accounts, you have three options:
1. **Apply parent account settings across all child accounts**
When this setting is enabled, all customised rate settings configured in the parent account will automatically apply to each child account. This means any rate customisations made within individual child accounts will be overridden by the parent account settings.
* **Standardised Rates Across Locations**
If you’ve customised rates in the parent account to ensure consistency, for example, across multiple warehouses or stores, enabling this setting will apply those same rates across all child accounts. This ensures a unified experience for your customers, regardless of the child account.
* **Overriding Specific Customisations**
If you've customised rates in "Child Account A" but have this setting enabled, the child account will ignore its local customisations and instead display rates as set in the parent account.
2. **Customise rates for specific child accounts**
If you want to apply specific rate customisations to one or more child accounts, use the "Apply margin to the following child accounts" option when customising your shipping rates.\
3. **Applying different customised rates for child accounts**
You can apply unique customised rates per product code at the child account level. When customised rates are configured directly in a child account, they will override any rates inherited from the parent account.
## Important considerations
While the new settings page offers powerful customisation options, there are a few limitations to be aware of:
**Carrier name modification**
The carrier name itself cannot be changed. However, service names can be modified.
**Margins and zero-dollar rates**
Margins are not applied to base rates that return as $0. Carriers often return $0 when a service is unavailable, and adding a margin to these rates could mistakenly indicate the service is available. A component-aware NZ Post surcharge rule can set a flat value for a zero-value surcharge when that add-on is present in the carrier response.
**Viewing margin details in reports**
You can generate a [Shipping Price Report](/articles/orders-manifests-reports/reports/generating-reports) to see both base rates and margin rates for each order. This information is available in the "Margin" column of the report.
**Pricing visibility for 3PL child accounts**
For 3PL child accounts, you can hide the pricing breakdown from 3PL users so any applied margins are not visible. To do this, enable the following settings for the child account from the parent account:
* **Hide Courier Rates**
* **Display total price with margin (hide rate breakdown)**
Once these settings are enabled, only the total shipping price will be shown on unshipped orders.
If you need shipping price details for printed orders, you can generate a report from **Main Menu > Reports**.
## Related articles
- [Set up NZ Post Domestic](/articles/couriers/nz-post/how-to-set-up-nz-post-domestic)
- [Set up rates at checkout](/articles/rates-at-checkout/set-up-guides/set-up-rates-at-checkout)
- [Set up reusable shipping zones](/articles/configure-shipping-workflows/rules-and-automation/setting-up-reusable-shipping-zones)
- [View the quoted shipping cost for orders](/articles/4404304727695-view-the-quoted-shipping-cost-for-orders)
---
# Customise NZ Post Domestic rates
URL: https://support.starshipit.com/articles/15100000000020-customise-nz-post-domestic-rates
Canonical: https://support.starshipit.com/articles/15100000000020-customise-nz-post-domestic-rates
Markdown: https://support.starshipit.com/articles/15100000000020-customise-nz-post-domestic-rates.md
Updated: 2026-08-04
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Configure NZ Post Domestic base services, surcharges, sectors, and package pricing in Customise Rates.
Configure NZ Post Domestic custom rates by base service, surcharge, route sector, add-on, or package. This guide explains which options to choose and how to verify the final rate.
## Before you begin
Before creating a custom-rate rule:
- Set up [NZ Post Domestic](/articles/203806459-set-up-nz-post-domestic).
- Decide whether the rule should change the base service, a surcharge, or the full carrier rate.
- If you need sector-specific pricing, make sure the shipment has sender and destination addresses that can be used for the sector lookup.
## Create an NZ Post custom-rate rule
1. Go to **Settings > Customise Rates**.
2. Select **Add new carrier rates**.
3. Select **NZ Post Domestic** as the **Carrier**, then select the **Product**.
4. Select the part of the rate to customise under **Component**:
- **Base service** changes the main NZ Post service price.
- **Surcharge** changes an add-on price returned with the service.
5. For component-aware NZ Post pricing, select **Enable component-aware pricing for this rule**. Leave it turned off if the rule should continue to customise the full carrier rate using the existing all-in behaviour.
6. If you selected **Surcharge**, choose a specific **Add-on** or leave it as **All add-ons**.
7. Choose a **Sector** or leave it as **All sectors**:
- **Local**
- **1 Sector**
- **2 Sector**
- **Inter-Island**
8. Select a **Margin type** and enter the **Margin value**:
- **Add Percentage Margin** adds a percentage to the selected rate component.
- **Add Flat Margin Amount** adds a fixed amount.
- **Set Flat Rate** replaces the selected rate component with the amount you enter.
9. For **Add Flat Margin Amount** or **Set Flat Rate**, choose whether to **Apply fixed amount** **Once per order** or **Once per package**.
10. Optionally select a **Shipping zone** under **Conditions** to limit the rule.
11. If you manage child accounts, select the accounts under **Apply to child accounts**.
12. Select **Save**.
When component-aware pricing is enabled, the rule changes only the selected component. For example, a base-service rule can add a margin to the transport price while a separate rural-delivery rule changes only the rural surcharge. Other applicable surcharges remain in the final total.
:::important
Existing NZ Post rules keep their current all-in pricing behaviour unless you enable **Enable component-aware pricing for this rule**. Leave this option turned off when you want an existing rule to continue pricing the full carrier rate as it does today.
:::
## Match NZ Post sectors automatically
Starshipit can determine the NZ Post sector from the sender and destination addresses when matching a sector-specific custom-rate rule.
1. Go to **Settings > Couriers > NZ Post Domestic > Advanced**.
2. Enable **Use ChangeLog sector lookup for custom rates**.
3. Select **Save**.
The sector selected in the custom-rate rule is then matched against the shipment route when Starshipit requests the rate. If the lookup is not available for your account, use **All sectors** or contact [Support](https://help.starshipit.com) before creating sector-specific rules.
## Apply fixed amounts per order or package
For NZ Post **Add Flat Margin Amount** and **Set Flat Rate** rules:
- **Once per order** applies the fixed amount once, regardless of the number of packages.
- **Once per package** applies the fixed amount to each package in the shipment.
Existing rules default to **Once per order**. Choose **Once per package** only when the fixed amount should be charged for every package. Percentage margins are applied once per order.
:::note
For component-aware NZ Post pricing, a flat rate on the base service does not remove separately priced surcharges. The final rate includes the adjusted base service and applicable surcharge prices.
:::
## Check the customised rate
After saving, create or open an order with the matching NZ Post service and route. Check the rate breakdown to confirm:
- the expected base service or surcharge was adjusted;
- the correct sector and add-on were matched;
- a per-package fixed amount was applied to each package when selected; and
- the final total includes the other applicable NZ Post surcharges.
The same customisation is used when Starshipit refreshes rates, creates a label, or saves the shipment price.
## Related articles
- [Customise checkout rates](/articles/10633684708239-customise-checkout-rates)
- [Set up NZ Post Domestic](/articles/203806459-set-up-nz-post-domestic)
- [Set up reusable shipping zones](/articles/configure-shipping-workflows/rules-and-automation/setting-up-reusable-shipping-zones)
---
# Create rules for checkout rates
URL: https://support.starshipit.com/articles/5941927829775-create-rules-for-checkout-rates
Canonical: https://support.starshipit.com/articles/5941927829775-create-rules-for-checkout-rates
Markdown: https://support.starshipit.com/articles/5941927829775-create-rules-for-checkout-rates.md
Updated: 2026-08-20
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Set up rules to control checkout rate behaviour, such as surcharges, free shipping, or courier assignments.
:::note
If you set any margin rules, they will override the rates that you have set for your couriers under Settings > Checkout rates > Courier Configuration.
:::
{{video:youtube:fmSmi2ndu4M}}
## Understanding the order of rules
Rules apply from top to bottom in the list. This means when a condition is met in a rule at the top of the list, the rules engine won't apply other conditions in the list that conflict with the first rule.
For example:
* Our first rule says Condition weight >5kg Set the carriers for checkout as Australia Post
+ This means if the weight of the order is greater than 5kg, then only Australia Post will show on checkout.
* Our second rule says Condition weight >10kg Set the carriers for checkout as Aramex.
+ This means if the weight of the order is greater than 10kg, then only Aramex will show on checkout.
In this case, the second rule will never be triggered. This is because any order that is greater than 10kg, will also be greater than 5kg, meaning the first rule will take precedence.
As the rules engine is flexible, you can solve this problem in a couple of different ways:
* Solution 1: Condition weight >5kg and condition weight <10kg Set the carriers for checkout as Australia Post.
+ This rule solves the issue by providing a range: Show Australia Post for orders heavier than 5kg and lighter than 10kg. Show Aramex for orders weighing more than 10kg.
* Solution 2: Change the order of the rules so the order containing the >10kg condition is first on the list.
+ This solves the issue as the second rule (showing Australia Post) will now only trigger for orders under 10kg.
## Entering currency and weight using rules
* When using Shopify, dollar values need to be entered in cents ($100 = 10000, $80 = 8000). This is due to a limitation with the Shopify plugin.
* Weight values need to be entered in kilograms (10kg = 10)
## Setting up a rule
1. Go to **Settings** > **Checkout Rates** > **Rules**.
2. Select **Add a new rule**.
3. Choose the **Condition(s)** that the rule should apply in.
Possible Conditions:
* All Orders
* Destination Country Name
* Destination Country Code
* Destination Post Code - AU
* Destination Post Code - NZ
* Destination Post Code
* Destination State
* Destination Suburb or City
* Destination Street
* Destination Building
* Destination Company
* Item SKU
* Item Quantity
* Order Value
* Order Weight
* Customer Tags (only for Shopify)
* PO Box & Parcel Locker Orders
* Line Item Value
* Shipping Zone
* Their Reference
4. Choose the **Action** you would like to apply.
* Set Carriers for Checkout: Only display the selected courier options on checkout
* Set Checkout Rates: Use a specified rate rather than the default couriers you have defined
* Set Courier & Product Code: Specify the courier that should display in this case
* Set Margin Type & Value: Add or subtract a margin from the quoted rate on checkout
* Set Shipping Location: Use an alternate shipping address from your Pickup Address defined in Starshipit as the sender address for the rate. This is useful if you are shipping from multiple locations and would like the live rate to be based on a specific address depending on what is in the cart or where the customer is based.
5. Click **Save**
:::important
For Table Rates product codes, the *Set Courier & Product Code* rule only works when using the **Plain Label – Table Rates** option. If you are using any other courier’s **Table Rates** option, this rule will not apply. This means you cannot use this rule to specify a product code that has been set up under Table Rate unless it is under Plain Label(Flat Rate) Table Rate.
:::
## Show different rates to Shopify customer groups
For Shopify checkout rates, the **Customer Tags** condition can match the tags on the customer requesting the rate. Use it to show different delivery options to groups such as wholesale and retail customers.
1. In Shopify, add the customer tag you want to use, such as `B2B`.
2. In Starshipit, go to **Settings > Checkout Rates > Rules**.
3. Create a rule with **Customer Tags** as the condition and enter the customer tag.
4. Choose **Set Carriers for Checkout** or **Set Checkout Rates** as the action.
5. Select the delivery options that customer group should see, then click **Save**.
Test the rule at checkout with a customer that has the tag. Place more specific tag rules above broader rules so the intended delivery options are returned.
## Common use cases for rules at checkout
#### How can I cover my surcharges?
Some couriers may apply a surcharge if a package is over a specific weight, but this surcharge isn’t always provided on the quote you get back from the courier. You can set up a rule to specify that if a package weighs over a certain amount, add a 10% margin to cover the surcharge.
1. Select **Add a new rule.**
2. Select **Condition(s)** > **Order weight** (Enter your weight threshold in the field provided).
3. Select **Action** > **Set Margin Type & Value**.
4. Select **Value** (Choose your courier from the dropdown).
5. Input your **product code**.
6. Select your **margin type** (Amount or percentage).
7. Enter your **value** (10%).
8. Click **Save.**
#### How can I account for PO boxes?
Not all couriers deliver to PO boxes. You can set up a rule which says that if an address includes a PO box, remove those couriers that won’t deliver to them.
1. Select **Add a new rule**.
2. Select **Condition(s)** > **PO Box & Parcel Locker Orders > Equals > True**.
3. Select **Action** > **Set Carriers for Checkout**.
4. Select the couriers you’d like to display in your checkout.
5. Click **Save**.
#### Can I display free shipping based on order value?
You can set up a rule where if an order is over $100 (for example), you can display a free shipping option to the customer.
1. Select **Add a new rule**.
2. Select **Condition(s)** > **Order Value > Greater Than >** (Enter your order value, for example $100. Note, this needs to be entered as 10000)
3. Select **Action > Set Checkout Rates**.
4. Select **Value** (Choose your courier from the dropdown).
5. Select **Free Shipping**.
6. Click **Return this item only**.
7. Click **Save**.
You can customise this further by adding additional conditions (such as below a certain order weight, or within a certain destination).
#### Can I set specific couriers for dangerous goods?
Some couriers won’t transport dangerous goods (Something flammable or even an item which includes a dangerous item like a battery). You can create a rule to remove these couriers from the checkout if the card contains a dangerous item.
1. Select **Add a new rule**.
2. Select **Condition(s)** > **Item SKU** > (Enter the SKUs of your dangerous goods items).
3. Select **Action > Set Carriers for Checkout**.
4. Select the couriers you’d like to display in your checkout.
5. Click **Save**.
#### Can I set alternate shipping locations?
If you ship from multiple locations, you may want to provide a live rate based on the warehouse the order will ship from. You could create a rule which says if the order is in state/country A, use warehouse A. Or, if the order is in state/country B, use warehouse B.
1. Select **Add a new rule**.
2. Select **Condition(s)** >**Destination Country Name** or **Destination State**.
3. Select **Action > Set Shipping Location**.
4. Enter your **Value** (The name of your shipping location).
5. Click **Save**.
## Troubleshooting
#### Why are my rules not working?
There are a few reasons why your rules may not be working:
* Rules apply from top to bottom in the list, so you may have conflicting rules. See the section “Understanding the order of rules” at the top of this article.
* With Shopify dollar values need to be entered in cents ($100 = 10000, $80 = 8000)
* Weight values need to be entered in kilograms (10kg = 10).
* If you’ve entered a weight for the order to be less than, your orders could be going above that weight and therefore the rules aren't applying as you intend them too. You may need to provide a range for orders to sit within instead of having a “less than” option.
#### Why isn't the right courier service selected on an imported order with checkout rates?
While this isn't default behaviour, it is recommended that you set up rules to map the 'Shipping Method' to the 'Select Courier and Product Code' action.
---
# Configure recommended packaging at checkout
URL: https://support.starshipit.com/articles/12219449620111-configure-recommended-packaging-at-checkout
Canonical: https://support.starshipit.com/articles/12219449620111-configure-recommended-packaging-at-checkout
Markdown: https://support.starshipit.com/articles/12219449620111-configure-recommended-packaging-at-checkout.md
Updated: 2026-06-23
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Use recommended packaging to calculate optimal box sizes for accurate live shipping rates at Shopify and WooCommerce checkout.
## How it works
At checkout, Starshipit determines the most efficient packaging for an order using product dimensions and your saved package options. Here’s how the process works:
:::note
Recommended Packaging is available on Professional plans and above. For Shopify checkout, products need dimensions from the Product Catalogue with **Use on checkout** enabled, or dimensions supplied directly on the checkout request.
:::
1. **Customer adds items to their cart and proceeds to checkout**
The checkout process sends the cart details, including SKUs and quantities, to Starshipit.
2. **Retrieving product dimensions**
If your platform sends dimensions on the checkout request, Starshipit can use those dimensions. For Shopify, Starshipit does not look up Product or Product Variant dimension metafields during checkout-rate requests.
If no dimensions are available on the checkout request, Starshipit matches SKUs to the Product Catalogue (if enabled for checkout) and uses those dimensions.
Items without dimensions are treated as loose items. If all items lack dimensions, the default package is used.
3. **Selecting package options**
Starshipit retrieves available packaging from your account settings.
4. **Determining the optimal packaging**
The algorithm prioritises the fewest number of packages while ensuring all items fit.
If multiple packages could work, it selects the one with the least empty space to reduce costs.
5. **Sending package details to the courier**
The final package dimensions are sent to your courier to calculate shipping rates.
6. **Returning the shipping rate to checkout**
The calculated shipping cost is returned to checkout and displayed to the customer.
## Setup steps
1. **Ensure products have dimensions**
For Shopify checkout, set accurate dimensions in the Product Catalogue ([Set up Product Catalogue](/articles/integrations/product-catalogue/product-catalogue)). Shopify Product or Product Variant dimension metafields are used for imported orders, not checkout-rate dimension lookup.
2. **Enable Product Catalogue at checkout**
Go to **Settings > Product Catalogue** and tick **Use on checkout**.
3. **Set your packaging dimensions**
Go to **Settings > Packaging** and enter your packaging dimensions.
4. **Enable Recommended Packaging for checkout**
Navigate to **Settings > Checkout Rates** ([Set up Checkout Rates](/articles/rates-at-checkout/set-up-guides/set-up-rates-at-checkout)) and select **Automatically Assign Packages based on dimensions**.
## FAQs
Will these packages be remembered when orders import?
Not automatically. Configure your packaging settings to match your checkout preferences.
What happens if my items don't have dimensions?
If dimensions are missing, your default package will be used.
What if one item in an order doesn't have dimensions?
This item will be treated as loose, and other items will be packaged excluding it.
What if my item dimensions are less than 1cm?
Recommended Packaging does not support decimal dimensions. Product and package dimensions must be at least 1cm for the checkout calculation to work correctly.
If you sell items with dimensions under 1cm, use Shopify shipping profiles to control when live rates are offered, or review whether another checkout shipping setup is a better fit.
Which platforms currently support Recommended Packaging?
Recommended Packaging is supported on:
* **Shopify** — requires Product Catalogue dimensions with **Use on checkout** enabled, or dimensions supplied directly on the checkout request
* **WooCommerce** — requires product dimensions set up in WooCommerce or the Product Catalogue
## Additional resources
* [Automatically assign packages based on item dimensions (order import)](/articles/getting-started/how-to-guides/how-to-assign-packages-automatically-based-on-item-dimensions-recommended-packaging)
* [Import optional data from Shopify](/articles/integrations/shopify/shopify-import-optional-data#product-dimensions-metafields) for Shopify order import dimensions
* [How to set up Product Catalogue](/articles/integrations/product-catalogue/product-catalogue)
* [How to set up Checkout Rates](/articles/rates-at-checkout/set-up-guides/about-live-rates-at-checkout-supported-couriers)
---
# Configure multi-origin rates with the Starshipit API
URL: https://support.starshipit.com/articles/4408809144463-configure-multi-origin-rates-with-the-starshipit-api
Canonical: https://support.starshipit.com/articles/4408809144463-configure-multi-origin-rates-with-the-starshipit-api
Markdown: https://support.starshipit.com/articles/4408809144463-configure-multi-origin-rates-with-the-starshipit-api.md
Updated: 2026-06-15
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Configure multi-origin shipping rates via the Starshipit API for orders fulfilled from multiple locations.
## Configure multi-origin rates with the Starshipit API
This guide is for custom integrations calling the Starshipit API directly. If you use Shopify checkout, follow [Shopify: Rates at checkout](/articles/rates-at-checkout/platform-specific-guides/shopify-rates-at-checkout) instead.
Before you begin, make sure you have activated [live rates](/articles/rates-at-checkout/set-up-guides/set-up-rates-at-checkout) in each Starshipit account you want to quote from.
The [Starshipit API rates endpoint](/developers/api-reference/starshipit#endpoint-rates-post-api-rates-get-rates) returns shipping services based on the origin included in the API request. To quote from multiple origins, send one rate request per location, then aggregate the returned services in your integration.
There are two common ways to configure this.
## Option 1: Use the location's API token
Use this option if you have a separate child account for each fulfilment location.
All Starshipit API requests include a `StarShipIT-Api-Key` header. This header determines which account the request is sent to. If each location has its own child account, send the rate request with that child account's API token. Starshipit will use that account's pickup address as the quote origin.
If you also create orders through the API, create the order using the same API token that returned the selected rate.
Example request:
```json
{
"url": "https://api.starshipit.com/api/rates",
"method": "POST",
"headers": {
"Content-Type": "application/json",
"StarShipIT-Api-Key": "",
"Ocp-Apim-Subscription-Key": ""
},
"data": {
"destination": {
"street": "20 George Street",
"suburb": "Sydney",
"city": "Sydney",
"state": "NSW",
"post_code": "2000",
"country_code": "AU"
},
"packages": [
{
"weight": 0.5
}
]
}
}
```
## Option 2: Send the origin address
Use this option if you want to pass the quote origin directly in the request instead of mapping each location to an API token.
The rates endpoint has an optional `sender` address object. Populate this with the location you want to quote from. In this option, your integration does not need to know which API token belongs to which address.
Example request:
```json
{
"url": "https://api.starshipit.com/api/rates",
"method": "POST",
"headers": {
"Content-Type": "application/json",
"StarShipIT-Api-Key": "",
"Ocp-Apim-Subscription-Key": ""
},
"data": {
"destination": {
"street": "20 George Street",
"suburb": "Sydney",
"city": "Sydney",
"state": "NSW",
"post_code": "2000",
"country_code": "AU"
},
"sender": {
"street": "100 Beaumont Street",
"suburb": "Menzies",
"state": "WA",
"post_code": "6436",
"country_code": "AU"
},
"packages": [
{
"weight": 0.5
}
]
}
}
```
## More information
* Read the [Starshipit API Overview](/articles/integrations/the-starshipit-api/starshipit-api-overview).
* For API support, contact our [support team](https://help.starshipit.com).
---
# Shopify: Set up rates at checkout
URL: https://support.starshipit.com/articles/208112753-shopify-set-up-rates-at-checkout
Canonical: https://support.starshipit.com/articles/208112753-shopify-set-up-rates-at-checkout
Markdown: https://support.starshipit.com/articles/208112753-shopify-set-up-rates-at-checkout.md
Updated: 2026-06-23
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Set up live rates at checkout for Shopify so customers can see real-time shipping costs.
:::note
Shopify sends weight to Starshipit for live rates. To use item dimensions in Shopify checkout rates, configure dimensions in the Product Catalogue and enable Product Catalogue for checkout.
:::
## About live rates at checkout
Starshipit uses the destination address and the total weight of the cart to return a quote for each of your couriers. For checkout packaging settings that require item dimensions, Starshipit can use Product Catalogue dimensions when Product Catalogue is enabled for checkout.
Shopify Product or Product Variant dimension metafields can be imported onto Shopify orders in Starshipit, but they are not looked up during Shopify checkout-rate requests.
Your customer can select the preferred shipping method and the order will be imported into Starshipit with this shipping method.
## Before you begin
* [Enable third-party calculated shipping rates](https://help.shopify.com/en/manual/fulfillment/setup/shipping-rates/third-party-carrier-calculated-shipping) in your Shopify account. Shopify includes third-party carrier-calculated shipping on Advanced and Plus plans. Shopify Grow stores can add it for an additional monthly fee or by switching to Shopify annual billing. Contact Shopify Support for help with plan eligibility.
* Configure [rates at checkout](/articles/rates-at-checkout/set-up-guides/set-up-rates-at-checkout) in Starshipit.
* Optional: To use item dimensions with supported checkout packaging settings, configure Product Catalogue dimensions and enable **Use on checkout** in [Product Catalogue](/articles/integrations/product-catalogue/product-catalogue).
* Enable Starshipit in the relevant shipping zones in Shopify. Log in to your Shopify store and ensure you have zones and rates configured under **Settings > Shipping and delivery**. You should see **Starshipit (Rates provided by app)** in this list. If you don't, under **Rate type**, click **Add Rate** and select **Use carrier or app to calculate rates** to reveal Starshipit from the dropdown.
* Enable **Delivery Options** in **Settings > Integrations > Shopify** in Starshipit.
* Enable carrier services under **Settings > Checkout Rates > Carrier Configuration** in Starshipit. If you add new services, toggle Delivery Options off and on again so Shopify refreshes the available services.
## Activate the rates in Starshipit
Once you've enabled the third-party calculated shipping rates in Shopify, you need to activate the rates in Starshipit.
1. In [Starshipit](https://app2.starshipit.com/), go to **Settings >** **Integrations**.
2. Find Shopify in the list and click **Settings**.
3. Select **Enable Delivery Options**.
4. Click **Save**.
Your customer will now see live rates at checkout.
## Rates not showing at checkout
If Starshipit rates are not appearing in Shopify checkout, work through this checklist:
1. Confirm Shopify third-party carrier-calculated shipping is enabled for your store.
2. Confirm Starshipit is added to the relevant Shopify shipping zone under **Settings > Shipping and delivery** as **Starshipit (Rates provided by app)**.
3. Confirm **Delivery Options** is enabled in **Settings > Integrations > Shopify** in Starshipit.
4. Confirm the required carrier services are enabled in **Settings > Checkout Rates > Carrier Configuration** in Starshipit.
5. If new services were added, toggle **Delivery Options** off and on again so Shopify refreshes them.
6. Confirm all Shopify products in the cart have weights.
7. Confirm your checkout rate rules are not hiding the service.
8. Disable duplicate Shopify flat rates if customers see duplicate shipping options.
Use **Settings > Checkout Rates > Logs** in Starshipit to check whether Shopify is sending a request. If there is no log for the checkout attempt, check the Shopify shipping zone and Starshipit app rate setup first. If there is a log but no rate, check the carrier service, checkout rules, product weight, Product Catalogue checkout dimensions, and package settings.
## Best practices
* Ensure all products have accurate weights. Carrier-calculated rates depend on weight, so rates may be incorrect or fail if product weights are missing.
* If you use item dimensions for checkout packaging, set up Product Catalogue dimensions and enable **Use on checkout**.
* Shopify Product or Product Variant dimension metafields apply to imported orders in Starshipit, not Shopify checkout-rate requests.
* Use the [Product Catalogue](/articles/integrations/product-catalogue/product-catalogue) to keep product data consistent for matching, customs details, and checkout-rate package selection.
* Disable existing flat shipping rates on Shopify to avoid duplicate shipping rate display at checkout.
* When creating checkout rate rules based on order value, enter the amount in cents (e.g. $100 = 10000, $80 = 8000).
---
# Shopify: Display transit times at checkout
URL: https://support.starshipit.com/articles/360001634936-shopify-display-transit-times-at-checkout
Canonical: https://support.starshipit.com/articles/360001634936-shopify-display-transit-times-at-checkout
Markdown: https://support.starshipit.com/articles/360001634936-shopify-display-transit-times-at-checkout.md
Updated: 2026-05-07
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Display estimated delivery transit times at checkout for Shopify stores.
## How to display transit times at checkout
1. Log into your [Starshipit](https://app2.starshipit.com/) account.
2. Go to **Settings** > **Couriers**> **Australia Post** or**DHL Express**
3. Select **Display transit times**.
4. Write a description in the free text field that makes sense to you, e.g. the name of the courier provider.
5. Click **Save**.
With transit times enabled, your checkout might look like this:
Without, it might look like this:
---
# WooCommerce: Set up rates at checkout
URL: https://support.starshipit.com/articles/360000076415-woocommerce-set-up-rates-at-checkout
Canonical: https://support.starshipit.com/articles/360000076415-woocommerce-set-up-rates-at-checkout
Markdown: https://support.starshipit.com/articles/360000076415-woocommerce-set-up-rates-at-checkout.md
Updated: 2026-09-08
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Set up live rates at checkout for WooCommerce so customers can see real-time courier pricing.
## About live rates at checkout
Starshipit uses the destination address and the total weight of the cart to electronically return a quote for each of your couriers. Your customer can select the preferred shipping method and the order will be imported into Starshipit with this shipping method.
## How to set up
#### 1\. Install the plugin
1. Download the [WooCommerce Plugin](/uploads/attachments/plugins/woocommerce-starshipit-services.4.0.0.zip).
2. Go to your WooCommerce dashboard, select **Plugins**, then select **Add New**.
3. Click **Upload Plugin**.
4. Click **Choose file** and upload the extension file from your computer. Make sure you activate the plugin.
5. Click **Install Now**.
#### 2\. Generate your API key in Starshipit
1. In your [Starshipit account](https://app2.starshipit.com/), go to **Settings >** **API**.
2. Copy the API key. You will need to enter this in WooCommerce.If the API Key field is blank, click Regenerate, then click **Save**.
#### 3\. Add your API key in WooCommerce
1. Go to your WooCommerce dashboard, select **WooCommerce**, then select **Settings**.
2. Select the **Shipping** tab, then select **Starshipit Shipping Rates**.
3. Paste the Starshipit API key, and select **Enable rates at checkout**.
4. In the **Options** menu, set the checkout rate weight unit to match the weight unit used for your products in WooCommerce.
5. Click **Save changes**.
Your courier rates should now be displayed in your WooCommerce checkout.
### **What's Next?**
Learn how to set up rates at checkout in [this article](/articles/rates-at-checkout/set-up-guides/set-up-rates-at-checkout).
To change the display name or remove services, go to your [Starshipit account](https://app2.starshipit.com/) \> **Settings** \> **Checkout Rates.**
---
# BigCommerce: Set up rates at checkout
URL: https://support.starshipit.com/articles/360000965275-bigcommerce-set-up-rates-at-checkout
Canonical: https://support.starshipit.com/articles/360000965275-bigcommerce-set-up-rates-at-checkout
Markdown: https://support.starshipit.com/articles/360000965275-bigcommerce-set-up-rates-at-checkout.md
Updated: 2026-05-07
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Set up live rates at checkout for BigCommerce so customers can see real-time courier pricing.
## About live rates at checkout
Starshipit uses the destination address and the total weight of the cart to return a quote for each of your couriers electronically. Your customer can select the preferred shipping method and the order will be imported into Starshipit with this shipping method.
## 1. Install the app in BigCommerce
1. Go to the [BigCommerce app store](https://www.bigcommerce.com/apps/starshipit/).
2. Click **Get** **this** **app** to install the Starshipit app in your BigCommerce store.
3. You will be asked to log in to your BigCommerce account if you aren't already logged in.
## 2. Generate your API key in Starshipit
1. In Starshipit, navigate to **Settings** > **API**.
2. If the API Key field is blank, click **Regenerate**, then click **Save**.
3. Copy the API key. You will need to enter this in BigCommerce.
## 3. Add your API key in BigCommerce
1. Log in the BigCommerce portal.
2. Select **Settings**, under**Setup** select **Shipping**.
3. Select to **Edit** your shipping rules in your **Checkout Shipping Options**.
4. Under **Real-time** **shipping** **quotes**, find **Starshipit**, and click **Connect**.
5. Select the **Connection** tab.
6. Paste the API key, then click **Submit**.
7. Repeat steps 3-6 for other shipping rules.
Your courier rates will now display in your BigCommerce checkout.
---
# Adobe Commerce (Magento 2): Set up rates at checkout
URL: https://support.starshipit.com/articles/360000324976-adobe-commerce-magento-2-set-up-rates-at-checkout
Canonical: https://support.starshipit.com/articles/360000324976-adobe-commerce-magento-2-set-up-rates-at-checkout
Markdown: https://support.starshipit.com/articles/360000324976-adobe-commerce-magento-2-set-up-rates-at-checkout.md
Updated: 2026-05-07
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Set up live rates at checkout for Adobe Commerce (previously Magento) platform using the Starshipit extension.
## Live rates at checkout
Starshipit uses the destination address and the total weight and dimensions of the cart to electronically return a quote for each of your couriers. Your customer can select the preferred shipping method and the order will be imported into Starshipit with this shipping method.
#### How to use dimensions for live rates
Starshipit supports dimensions for live rates at checkout for Adobe Commerce. To start using dimensions, you will need to create **custom attributes** in your Adobe Commerce store.
To create a custom attribute:
1. Open your Adobe Commerce admin panel.
2. Navigate to **Stores** > **Attributes** > **Product**.
3. Click the **Add New Attribute** button.
4. Create the following custom attributes using the exact spelling (not case-sensitive) under the **Attribute Label** field:
* Length
* Height
* Width
5. Leave the Catalog input Type as **Text Field**.
6. Click **Save Attribute** for each attribute.
All custom attributes created for one product will also be created for all products as empty fields. If the fields are empty or if the customer sets a non-numeric character in the dimension, Starshipit will assume the value as zero when getting rates.
Once the attributes are added, live rates using dimensions will be available to customers immediately.
## 1. Install the extension app
Before installing any extension, please create a backup of the root folder of the Adobe Commerce website and of the database.
1. Download the [Adobe Commerce Extension File](/uploads/attachments/plugins/starshipit-services-3.0.0.zip).
2. Unpack the **starshipit-services-3.0.0.zip** file you've downloaded.
3. Connect to the server where the website source folder is located with FTP/SFTP/SSH client.
4. Upload all files and folders that you have unpacked to the root folder of your Adobe Commerce website.
5. Connect to your Adobe Commerce directory with SSH.
6. Run the following commands:
1. php bin/magento setup:upgrade
2. php bin/magento setup:di:compile
3. php bin/magento setup:static-content:deploy
## 2. Generate your API key in Starshipit
1. Log in to your Starshipit account.
2. Go to **Settings**, then select **API**.
3. If the API Key field is blank, click **Regenerate**, then click **Save**.
4. Copy the API key. You will need to paste it into your Adobe Commerce Admin panel.
## 3. Add your API key in Adobe Commerce
1. Go to your Adobe Commerce Admin Dashboard, select **Stores**.
2. Under **Settings**, select **Configuration**.
3. Select **Sales**, then click **Shipping Methods**, and select **Starshipit** from the list.
4. Set **Enabled** to **Yes**.
5. Paste your API key from Starshipit in the **API Key** field.
6. Fill in the required fields according to your preferences.
7. Click **Save Config**.
Your checkout should now display your Starshipit live rates.
---
# Wix: Set up rates at checkout
URL: https://support.starshipit.com/articles/7875543018639-wix-set-up-rates-at-checkout
Canonical: https://support.starshipit.com/articles/7875543018639-wix-set-up-rates-at-checkout
Markdown: https://support.starshipit.com/articles/7875543018639-wix-set-up-rates-at-checkout.md
Updated: 2026-05-07
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Set up live rates at checkout for Wix so customers can see real-time courier pricing.
## About live rates at checkout
Starshipit uses the destination address and the total weight of the cart to electronically return a quote for each of your couriers. Your customer can select the preferred shipping method and the order will be imported into StarShipit with this shipping method.
## How to get started
#### 1. Install the Starshipit app on the Wix App Market.
1. Go to the [Starshipit app on the Wix App Market.](https://www.wix.com/app-market/starshipit-shipping-tracking?referral=search-result&appIndex=0&referralTag=starshipit&referralSectionName=search-result)
2. Click **Add to site**.
3. Click **Agree & Add**.
You will be redirected to the Wix settings page in Starshipit. On this page, you can set the fullfilment status of imported orders and text the integration to make sure it works.
#### 2. Configure rates at checkout in Starshipit
Now that you've set up Wix with Starshipit, you'll need to configure which shipping options you'd like to display to customers at the point of purchase from within Starshipit.
* Follow our guide on [setting up rates at checkout.](/articles/rates-at-checkout/set-up-guides/set-up-rates-at-checkout)
#### 3. Enable Starshipit in the relevant shipping regions
For customers to see and select the new shipping option at checkout, you need to enable the app in your Wix dashboard.
You must enable the app in each region where you want customers to see it. For example, if you created 3 shipping regions, for Australia, the US, and New Zealand, and want the app to work in the first 2, you must enable the toggle for Australia and then enable the toggle for the US.
1. Go to [Shipping & fulfillment settings](https://www.wix.com/my-account/site-selector/?buttonText=Manage%20Shipping&title=Select%20a%20Site&autoSelectOnSingleSite=true&actionUrl=https://www.wix.com/dashboard/{{metaSiteId}}/store/shipping-and-tax/list?referralInfo=sidebar) in your site's dashboard.
2. Select a shipping region.
3. Scroll past any shipping, delivery, or pickup options you created.
4. Enable the toggle next to the shipping app.
5. If your app has a Rate at checkout field, enter a rate.
6. Repeat steps 2-5 for any additional regions.
:::note
When a shipping app is enabled, customers see any shipping options you created that are relevant for their region.
:::
:::note
This is a backup rate for rare cases where it's not possible to supply a real-time rate.
:::
## Troubleshooting
#### I've installed the Starshipit App, but cannot find it in the "Installed Apps" section within the shipping profile.
If you have previously installed the Starshipit App, you may need to uninstall the existing Starshipit App and then reinstall it in order to display the Starshipit App within the shipping profile. This is due to restrictions within Wix.
---
# PrestaShop: Rates at Checkout (DHL Express only)
URL: https://support.starshipit.com/articles/360000911475-prestashop-rates-at-checkout-dhl-express-only
Canonical: https://support.starshipit.com/articles/360000911475-prestashop-rates-at-checkout-dhl-express-only
Markdown: https://support.starshipit.com/articles/360000911475-prestashop-rates-at-checkout-dhl-express-only.md
Updated: 2026-05-07
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Set up DHL Express shipping rates at checkout for PrestaShop stores.
:::warning
This guide assumes that you have already installed our PrestaShop module, which is no longer supported and available in the marketplace.
:::
## 1. Configure Starshipit Module in PrestaShop
1. Go to **Modules** > **Module Manager**.
2. Find **Live Shipping Rates Module** by Starshipit
3. Click **Configure**.
4. Click **YES** to enable.
5. Enter **API key** from Starshipit Web Portal (Settings > API)
6. Leave **API Source** empty.
7. Click **Save**.
## 2. Enable DHL Express Shipping Rates via Starshipit API
1. In Starshipit, navigate to **Settings** > **Checkout Rates**.
2. Check the **Enable advanced setting view** box on the **Settings** tab.
3. Select the **Contract Rates** radio button for **DHL Express**.
4. Check the **Enable International Rates**.
5. Check **P** product code.
6. Click **Save**.
---
# Magento 1: Rates at checkout
URL: https://support.starshipit.com/articles/205940406-magento-1-rates-at-checkout
Canonical: https://support.starshipit.com/articles/205940406-magento-1-rates-at-checkout
Markdown: https://support.starshipit.com/articles/205940406-magento-1-rates-at-checkout.md
Updated: 2026-05-07
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Set up live rates at checkout for Magento 1 stores using the Starshipit extension.
:::warning
This guide assumes that you have already installed our Magento 1 extension, which is no longer supported and available in the marketplace.
:::
## About live rates at checkout
Starshipit uses the destination address and the total weight of the cart to electronically return a quote for each of your couriers. Your customer can select the preferred shipping method and the order will be imported into Starshipit with this shipping method.
## 1. Generate your API key in Starshipit
1. Log in to your Starshipit account.
2. Go to **Settings**, then select **API**.
3. If the API Key field is blank, click **Regenerate**, then click **Save**.
4. Copy the API key. You will need to paste this into your Magento Admin panel.
## 2. Add your API key in Magento 1
1. Log in to your Magento 1 account.
2. From the **System** menu, select **Configuration**.
3. From the side bar, select **ShipIt Settings**.
4. Paste your API key from Starshipit in the **API Key** field, then click **Save Config**.
5. From the side bar select **Shipping Methods**.
6. Under **ShipIT (Rate Service)**, set **Enabled** to **Yes**.
7. Set the **Calculate** option to **Yes**.
**WARNING!**The other ShipIt shipping methods are legacy options. These have been deprecated and should not be used.
Your checkout should now display your Starshipit live rates.
---
# Troubleshoot live rates at checkout
URL: https://support.starshipit.com/articles/360001872876-troubleshoot-live-rates-at-checkout
Canonical: https://support.starshipit.com/articles/360001872876-troubleshoot-live-rates-at-checkout
Markdown: https://support.starshipit.com/articles/360001872876-troubleshoot-live-rates-at-checkout.md
Updated: 2026-03-24
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Troubleshoot live rates at checkout, understand quote calculations, and fix issues when rates don't appear or match your courier contract.
This guide aims to help you understand the quotes you are seeing on checkout, what the rate is comprised of, and what to do when the rates do not appear or do not match your expected/agreed-upon contracted rates with your courier.
## How are rates calculated?
Before troubleshooting, it's important to understand how Starshipit generates and displays rates. Starshipit does not hold any accounts with the couriers, so the rates you are displayed on checkout are based on your contract with the courier.
As a first step, ensure that your rates are showing within the Starshipit application by following [this guide](/articles/rates-at-checkout/set-up-guides/set-up-rates-at-checkout).
If you have confirmed that rates are working and accurate in your Starshipit account but are not working or incorrect on your checkout, then you will need to check the following things.
Rates on checkout can be less accurate than the rates within the Starshipit dashboard. This is because on checkout, we have less information about the shipment in terms of how it will be packed. On checkout, the rate will be based on:
* Your account number with the courier (As defined in **Settings** \> **Couriers** \> \[**Courier Name**])
* Your sender address (As defined in **Settings** \> **Pickup Address**)
* Your package settings in **Settings** \> **Checkout Rates** \> **Weight and Dimensions**
* The destination of the shipment
* The total weight of the shipment
* The dimensions of the shipment\*
* The service with each courier you wish to use
* Any margins/rules/advanced configuration as defined in **Settings** \> **Checkout Rates**
\*Dimensions sent directly by a commerce integration are only supported for Magento and WooCommerce. Shopify sends weight only. To use item dimensions for Shopify rates, add matching SKU dimensions to the [Product Catalogue](/articles/integrations/product-catalogue/product-catalogue) and enable **Use on checkout** in **Settings > Product Catalogue**.
We bundle this information up and send it to the couriers' rating system, which they then interpret and tell us what the rate should be given these details.
## Troubleshooting
With this in mind, you may still be having problems with your rates.
### **My rates are incorrect**
If the rates on checkout look different from how you expect, there are a few things for you to check.
* Navigate to **Settings** \> **Checkout Rates** and ensure you have the correct services enabled.
* Check that the behaviour of rates is correct by creating an order in Starshipit, using the exact same weight and compare the prices with what is being used on checkout. For this, it's recommended that you first start with an order where the dimensions are 1 x 1 x 1 and the weight matches what you have in your platform. You can then adjust the dimensions and weights to see how this affects the price in Starshipit. Shopify does not send dimensions in the checkout-rate request. If you have enabled Product Catalogue for checkout, Starshipit can use matching catalogue dimensions; otherwise, checkout uses your configured package settings. This can help determine whether the root cause of the issue is due to a carrier integration or package setup, rather than checkout rates.
* Use our Test Tool in **Settings** \> **Checkout Rates** \> **Tools** and enter in an address and weight. Select API, Shopify / Magento, WooCommerce or Tiandanube then click on **Get Rates**. You should then be able to see what rules were applied, and the carriers that were called.
* You can run a test from your store to use the logs to get the same information as above.
* Go to the Logs tab, find the request using the time column or by searching by an address property.
* Click the triple dot button to open the request where you can find the same information as step two.
* Check **Settings** \> **Checkout Rates** \> **Weight and Dimensions** to confirm the package settings you have set up.
* If you are using a platform that supports dimensions ensure you have selected the right setting from here.
* Go to **Settings** \> **Options** and ensure that the weight unit for checkout is correct.
* Alternatively, feel free to reach out to our [support team](https://help.starshipit.com) who can help point you in the right direction.
#### Oversized or overweight surcharges
Some couriers apply oversized/overweight surcharges after the parcel is scanned and measured by the courier. These surcharges are not always included in the rate quote returned at checkout, so the checkout rate may be lower than the final courier charge.
If you know certain items are likely to incur surcharges, you can use checkout rate rules to apply a margin based on:
* **Item SKU** — apply a margin when the cart contains specific SKUs.
* **Order weight** — apply a margin when the order exceeds a threshold.
See [Rules for checkout rates](/articles/rates-at-checkout/set-up-guides/rules-for-checkout-rates) for examples.
### **My rates aren't showing**
The way the rates plugin works is:
1. On checkout, the plugin will look at the items in the cart and send a request to Starshipit app.
2. Starshipit app will see the request and then forward this to the courier.
3. The courier will generate a rate and return it to Starshipit.
4. Starshipit will then forward this back to your checkout.
There are various different places where this can fail, so understanding the point at which the workflow is not working will help you pinpoint the issue. Here are some things to check:
* Go to **Settings** \> **Checkout Rates** \> **Logs**. If you can see nothing in here, that means that step one is failing. This will be a problem with how you have set up the plugin. Follow through the plugin's set up guide again, reinstall the plugin and ensure all API keys etc. are correct. It could also be that you have a shipping zone on your checkout that is preventing the plugin from being called.
* If you can see logs, but nothing is displaying it's likely that the courier is not enabled for checkout rates. Go to **Settings** \> **Checkout Rates** \> **Courier Configuration** and ensure the courier service is ticked. Also make sure that you don't have any rules in **Settings** \> **Checkout Rates** \> **Rules** that would hide the rates.
* Make sure that the values being sent through are correct. E.g. the weight is too high, the destination is incorrect.
* Use our Test Tool in **Settings** \> **Checkout Rates** \> **Tools** and enter in an address. What you see here should be reflected on checkout. If nothing is showing here, try the next step.
* Make sure you have enabled [live rates at checkout](/articles/rates-at-checkout/set-up-guides/about-live-rates-at-checkout-supported-couriers) by following the set-up guide for the eCommerce platform you are setting up rates for.
* If it is only certain addresses then it is likely that the courier isn't returning a rate for that address. Try to create an order in the new tab with the same address, weight, dimensions and see if you can get a rate.
* Alternatively, feel free to reach out to our [support team](https://help.starshipit.com) who can help point you in the right direction.
---
# Troubleshoot unexpected rates and quotes
URL: https://support.starshipit.com/articles/6121166412175-troubleshoot-unexpected-rates-and-quotes
Canonical: https://support.starshipit.com/articles/6121166412175-troubleshoot-unexpected-rates-and-quotes
Markdown: https://support.starshipit.com/articles/6121166412175-troubleshoot-unexpected-rates-and-quotes.md
Updated: 2026-05-07
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Troubleshoot rates and quotes in Starshipit, understand how rates are calculated, and fix issues when rates don't match your courier contract.
This guide aims to help you understand the quotes you are seeing for your shipments within Starshipit, what the rate is comprised of, and what to do when the rates do not seem to match your expected/agreed-upon contracted rates with your courier.
## How are rates calculated?
Before troubleshooting, it's important to understand how Starshipit generates and displays rates. Starshipit does not hold any accounts with the couriers, so the rates you are displayed within the app are based on your specific contract.
To generate a rate for any courier we use the following information:
* Your account number with the courier (As defined in **Settings** > **Couriers** > [**Courier Name**])
* Your sender address (As defined in **Settings** > **Pickup Address**)
* The destination of the shipment
* The total weight of the shipment
* The dimensions of the shipment
* How many packages are in the shipment
* Any options (Insurance/Signature Required/Authority to Leave etc)
* The service with each courier you wish to use
We bundle this information up and send it to the couriers' rating system, which they then interpret and tell us what the rate should be given these details. From here, we will display this in Starshipit (without altering or amending the rate in any way).
## Troubleshooting
With this in mind, you may still be having problems with your rates.
### My rates are incorrect
If the rates in Starshipit look different from how you expect, there are a few things for you to check.
1. The easiest first step is to create an order in Starshipit, and one in the courier portal, and compare the prices. For this, it's recommended that you first start with an order where the dimensions are 1 x 1 x 1 and the weight is 1kg. You can then adjust the dimensions and weights to see how this affects the price in Starshipit.
2. Different delivery options can have additional fees, for example, some couriers charge extra to obtain a signature, Saturday delivery, or to apply insurance. When you're comparing the prices, ensure you have the exact same options selected in both portals.
3. Starshipit's rates rely on what is returned from the courier API, this can mean that in certain cases the rates in the Starshipit portal do not show all the surcharges and taxes in the price. To see what the rate comprises of:
* In [UI 2.0](/articles/getting-started/how-to-guides/switching-between-classic-ui-and-ui-2-0), we have included a shipping price breakdown which will list out the components of the rates so you know what the price is including:
* In the classic UI, if you hover over the quoted price in the order dialog, most couriers have a tool tip which shows the breakdown of the quote:
4. If you've checked all these, we recommend reaching out to your account manager at the courier as it is likely that they have loaded in the wrong rates for your account. If you let them know the prices you are seeing, they should be able to quickly rectify this
5. Alternatively, feel free to reach out to our support team who can help point you in the right direction.
### My rates aren't showing
If this is a new courier you are adding to Starshipit and the rates aren't showing, it's likely that there has been an issue with setting up your courier integration. Try the below steps:
1. Go through the related [courier setup guide](/categories/couriers) and ensure you have completed each step. Make sure you have added the product codes you intend on using with the courier.
2. Ensure you haven't accidentally added any whitespace to the account number or any of the API key fields
3. If you're still having trouble, reach out to our support team who can help point you in the right direction
If this is an existing courier where suddenly the rates stop displaying, this is likely an issue with your contract with the courier or a courier system outage.
1. Check status.starshipit.com to ensure that there are no reported courier outages
2. Contact your courier account manager and ask them to check your contract. Things they should be looking out for:
* Your contract hasn't been canceled/put on hold
* There's no credit stop on the account
* All your products are loaded against your contract
3. If you've spoken to them and they aren't able to pinpoint the issue, reach out to our team who can find the exact error to help provide more context to your account manager
---
# Use pickup in store with Starshipit
URL: https://support.starshipit.com/articles/360000133456-use-pickup-in-store-with-starshipit
Canonical: https://support.starshipit.com/articles/360000133456-use-pickup-in-store-with-starshipit
Markdown: https://support.starshipit.com/articles/360000133456-use-pickup-in-store-with-starshipit.md
Updated: 2026-05-06
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Understand how to offer, configure, and process pickup in store orders with Starshipit.
Pickup in store is an alternative fulfilment method to courier delivery. A customer collects the order from your store or collection point, while Starshipit helps your team identify, label, notify, and complete the order.
## Choose the parts of the workflow you need
1. [Offer pickup in store at checkout](/articles/90200000000517-offer-pickup-in-store-at-checkout) if customers should select collection while placing an order.
2. [Enable pickup in store and configure labels](/articles/90200000000518-enable-pickup-in-store-and-configure-labels) so Starshipit can process and identify collection orders.
3. [Route imported orders to pickup in store](/articles/90200000000519-route-imported-orders-to-pickup-in-store) if your sales channel imports pickup orders with its own shipping-method name.
4. [Process a pickup in store order](/articles/90200000000520-process-a-pickup-in-store-order) when the order is ready to prepare for collection.
You can use the Starshipit pickup workflow even when customers choose pickup directly in your sales channel rather than through Starshipit rates at checkout.
---
# Offer pickup in store at checkout
URL: https://support.starshipit.com/articles/90200000000517-offer-pickup-in-store-at-checkout
Canonical: https://support.starshipit.com/articles/90200000000517-offer-pickup-in-store-at-checkout
Markdown: https://support.starshipit.com/articles/90200000000517-offer-pickup-in-store-at-checkout.md
Updated: 2026-07-20
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Add pickup in store as a customer collection option in Starshipit rates at checkout.
If you use Starshipit rates at checkout, add pickup in store as a free or fixed-price option alongside your courier delivery services.
## Before you begin
[Set up rates at checkout](/articles/360000179036-set-up-rates-at-checkout) before adding the pickup option.
## Add the pickup option
1. Go to **Settings** > **Checkout Rates** > **Courier Configuration**.
2. Enable **Advanced setting view**.
3. Under **Flat Rate**, select **Table Rates**.
4. Add a row with:
- **Product Code:** `PICKUP`
- **Product Name:** `Pickup In Store`
- **Country, state or postcode:** Add restrictions if only some customers can collect.
- **Shipping rates:** For example, `1000|0` offers free pickup for orders up to 1,000 kg.
5. Save your changes.
Next, [enable pickup in store in Starshipit](/articles/90200000000518-enable-pickup-in-store-and-configure-labels).
---
# Enable pickup in store and configure labels
URL: https://support.starshipit.com/articles/90200000000518-enable-pickup-in-store-and-configure-labels
Canonical: https://support.starshipit.com/articles/90200000000518-enable-pickup-in-store-and-configure-labels
Markdown: https://support.starshipit.com/articles/90200000000518-enable-pickup-in-store-and-configure-labels.md
Updated: 2026-07-20
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Enable the Pickup in Store service and choose how Starshipit creates collection labels.
Enable Pickup in Store as a Starshipit service so your team can identify and process collection orders without booking a courier shipment.
## Enable pickup in store
1. Go to **Settings** > **Couriers** > **Add a new courier**.
2. Under **Other**, select **Pickup in Store**.
3. Enable **Pickup in Store**.
4. Enable **Generate labels for Pickup in Store** if each collection order should have an identification label.
5. Save your changes.
## Customise the pickup label
1. Go to **Settings** > **Couriers** > **Pickup in Store** > **Label Template**.
2. Select a supplied template or **Customise your own**.
3. Add the order information your team needs, such as the order number, customer name, SKUs, collection location, or delivery instructions.
4. Save the template.
When your team prints a pickup order, Starshipit creates the pickup label from this template instead of requesting a courier label.
---
# Route imported orders to pickup in store
URL: https://support.starshipit.com/articles/90200000000519-route-imported-orders-to-pickup-in-store
Canonical: https://support.starshipit.com/articles/90200000000519-route-imported-orders-to-pickup-in-store
Markdown: https://support.starshipit.com/articles/90200000000519-route-imported-orders-to-pickup-in-store.md
Updated: 2026-07-20
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Use a shipping rule to assign sales-channel collection orders to Pickup in Store.
Sales channels often import collection orders with their own shipping-method name. Create a rule that recognises that name and assigns the Starshipit **Pickup in Store** service.
## Create the rule
1. Confirm the shipping method imported from your sales channel, such as `Local pickup` or `Click and collect`.
2. Go to **Settings** > **Rules**.
3. Add a rule where the imported shipping method matches your collection method.
4. Set the action to assign **Pickup in Store**.
5. Save the rule and test it with an order.
Create additional conditions if different stores or collection methods need different workflows.
---
# Process a pickup in store order
URL: https://support.starshipit.com/articles/90200000000520-process-a-pickup-in-store-order
Canonical: https://support.starshipit.com/articles/90200000000520-process-a-pickup-in-store-order
Markdown: https://support.starshipit.com/articles/90200000000520-process-a-pickup-in-store-order.md
Updated: 2026-07-20
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Prepare, label, notify, and complete an order that a customer will collect.
Process a pickup order when it has imported with **Pickup in Store** assigned or after you select that service manually.
1. Open the order and confirm **Pickup in Store** is the delivery option.
2. Pick and pack the items.
3. Print the order. If pickup labels are enabled, Starshipit prints the configured identification label without booking a courier.
4. Place the label on the packed order so your team can match it to the customer at collection.
5. Use your configured pickup notification to tell the customer when the order is ready.
For supported Shopify pickup workflows, Starshipit can write the order back as **Ready for pickup**.
---
# Set up email notifications
URL: https://support.starshipit.com/articles/206358536-set-up-email-notifications
Canonical: https://support.starshipit.com/articles/206358536-set-up-email-notifications
Markdown: https://support.starshipit.com/articles/206358536-set-up-email-notifications.md
Updated: 2026-03-06
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Step-by-step guide to setting up email notifications.
:::warning
Notifications will not be sent for "Pickup In Store" and "Plain Label" orders when on a Trial Subscription due to spam protection measures.
:::
## Classic and new notification template
You can create your email notifications using either our classic notification template or our new notification template.
* **Classic notification template –** Our classic HTML editor with the option of adding preset variables like courier name, Tracking URL, company name and more.
* **New notification template –** Our new email editor includes options for notices, tracking bubbles, promotion blocks and more.
## Choose your notification template
Before you can customise your notifications, you need to select which template you’d like to use:
1. In Starshipit, navigate to **Settings > Tracking & notifications**.
2. For each delivery stage, select which options you would like to enable
1. If all options remain unticked, no notification will be sent for this delivery stage
2. You can select to either send the new email template or the classic email template.
3. Click **Save**.
## Choose when to send delivery updates
Starshipit can manage an email template for each different delivery status and will trigger an email only for the checked status. For example, you can choose to send an email or SMS when an order label is printed to when the order is delivered.
* Enable the checkbox for the stages of delivery you want to notify a customer.
## Edit new template
Select the blue hyperlinked **New email template** to update that notifications template.
#### Edit your From details
Enter your from details so customers can easily identify who is sending them the email.
#### Add a notice
Display a banner message at the top of the page in the event that you need to make an announcement to your customers regarding shipping or handling.
Notices display across branded tracking, customer notifications, and returns.
1. Click **Enable** **notice section** to turn the notice banner on.
2. Write your notice in the field provided.
3. Click **Save**.
#### Notification email content
Use Starshipit variables to personalise your email and include information about the order.
1. Add a **Section title**.
2. Double-click a **variable** to add it to the field.
3. Click **Save**.
#### Tracking bubbles
Choose to show or hide the tracking bubbles from your branded tracking page. Tracking bubbles are enabled by default. If you want to turn off tracking bubbles:
* Under Branded tracking page template, click on **New tracking page template**.
* Untick **Enable tracking bubbles.**
* Click **Save**.
#### Add your contact information
List relevant ways customers can contact you if they have a question or require support post-purchase. Contact information is an optional section displayed across branded tracking, customer notifications, and returns.
1. Click **Enable contact information**.
2. Add your **Section title** – The header for this contact block.
3. Add your **Text** – The name of the contact field (Email, support page etc).
4. Add your **URL** – Where the contact section will link to.
5. Click **Add another** to add another contact section.
6. Click **Save**.
#### Add promotion blocks
Add a promotional image to your branded tracking page and enter an image URL to direct customers to on-click.
1. Click **Enable promotion blocks**.
2. Click **Select** to upload your image.
3. Enter your **URL** – where your image will link to when clicked.
4. Click **Save**.
#### Customise your footer
Use the footer to include any important information or links.
1. Click **Enable** footer section.
2. Write your message or add **URLs** in the **Content field**.
3. Click **Enable Starshipit watermark** to remove the Starshipit watermark.
4. Click **Save**.
#### Test your notifications
Send a test notification to an email address.
* Enter your **email address** and **click** the Captcha.
* Click **Send test**.
## Edit classic template
1. Select the blue hyperlinked **classic email template** to update that notifications template
2. From the editor, you can modify the email template as required.
## Use the Starshipit variable
Use Starshipit variables to personalise your email and include information about the order. Starshipit variables can be included in the subject field and in an HTML tag.
```
Track %OurRef% Online
```
### Variables:
* **Recipient name:** Name of your customer
* **OurRef:** Sender's reference (e.g. sales order number)
* **TheirRef:** Receiver's reference (e.g. purchase order number)
* **Courier Name:** The courier used to ship the parcel.
* **Tracking Number:** Tracking number associated with the parcel
* **Tracking URL:** Tracking URL associated with the parcel
* **Company Name:** Your company name
* **Telephone:** Your contact number
:::note
The Tracking Number and Tracking URL is optional as the email notification automatically includes the tracking information.
:::
### Add an image to the email
1. From the email editor, select **Upload Image**.
2. Click **Upload**.
3. Select an image from your computer
4. Click **Upload** from the dialogue box.
5. Select the image on the middle part of the screen
6. Click Insert.
### The sender email
If you would like to specify a specific email that your outbound notifications go from, you can go to:
1. **Settings** \> **Customer Notifications** \> **Email Template**.
2. Enter the email in the From field.
## Duplicate email notifications
Many eCommerce platforms (including **Shopify** and **Magento**) include notification options that email customers when the status of their order has been updated. If you have opted to write-back the status to your eCommerce platform, you may need to consider whether your customers are receiving duplicate notifications. You can then enable/disable notifications, as required.
:::warning
(Australia Post only)If you're shipping with Australia Post, check that you haven't enabledAustralia Post notifications.You can check this by going toStarshipit>Settings>Couriers>Australia Post>Advanced> untickEnable Email Notification for Tracking.
:::
## Multi-tracking support
You can display multiple packages with different tracking details within the same order and in a single notification.
This feature is useful for situations like the following:
For example, let's say your customer places an order for multiple items. Due to inventory location differences or various shipping methods, the order needs to be split into several packages, each with its unique tracking details.
With this functionality, the customer receives a single tracking notification containing every package, with different tracking details, instead of multiple emails.
#### How to activate this feature:
1. Log in to your [Starshipit](https://app2.starshipit.com/) account.
2. Navigate to **Settings** \> **Tracking and notifications**.
3. Scroll down to the **Customer notification templates** section.
4. Select both options:
* Send customer notifications per shipment, rather than per parcel.
* Combine multiple packages with different tracking details within an order into one notification.
5. Click **Save**.
:::note
When multiple tracking numbers are shown, they will be listed consecutively. We recommend reviewing and testing each template for formatting issues.
:::
## Troubleshooting
### Why do I see "Spam prevention has failed, please contact support" when testing a template?
This error can occur when your email template contains more than 3 links.
To resolve it:
1. Reduce the number of links in the template to 3 or fewer.
2. Save the template and re-run the test.
3. If you still see the error, contact [Starshipit support](https://help.starshipit.com).
#### Notifications are going straight to the customer's junk or being flagged as spam.
Run through the below steps:
1. Check if the From field has been entered in the customer notification template.
2. Ensure you have set up [DKIM](https://support.starshipit.com/knowledge/editor/01J6YPRNYEM4Q012Z0F0BQJFW7/en-us?brand_id=255115§ion_id=202188406).
3. If it has, you can then check the domain in https://mxtoolbox.com/spf.aspx and see if the SPF record exists.
4. If SPF record exists, then check if "sendgrid.net" is included in the SPF record, if it is not, then it appears that your domain has got SPF record configured.
5. You will need to include "sendgrid.net" in the TXT DNS record to avoid the email notification being marked as spam or getting bounced by the recipient's mail server.See our support article for more information on [SPF for email notifications](/articles/notifications-branded-tracking-rules-child-accounts/notifications/spf-for-email-notifications).
---
# Configure DKIM for your emails
URL: https://support.starshipit.com/articles/10640015724815-configure-dkim-for-your-emails
Canonical: https://support.starshipit.com/articles/10640015724815-configure-dkim-for-your-emails
Markdown: https://support.starshipit.com/articles/10640015724815-configure-dkim-for-your-emails.md
Updated: 2026-05-07
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Learn how to set up DKIM in your Starshipit account to verify your emails and improve deliverability.
## What is DKIM?
DKIM (DomainKeys Identified Mail) is a way to make sure the emails you send from your domain (e.g., yourstore.com) are verified as legitimate. It helps prevent emails from being marked as spam or junk mail by proving that they were really sent from your domain.
## Why set up DKIM?
Setting up DKIM helps your emails reach your customers’ inboxes by proving that they are sent by your business. It also protects your brand from being used in email scams like phishing.
## How to set up DKIM in Starshipit
1. **Enter your domain name**
1. In Starshipit, navigate to **Settings** > **Tracking & Notifications**.
2. Under **Sender authentication,** type the domain you want to send emails from (e.g., yourstore.com).
2. **Generate DKIM Records**
Click **Generate** to create three records (CNAME) you’ll need to add to your domain’s DNS settings.
3. **Add the CNAME Records to Your Domain**
1. Copy each CNAME record from Starshipit.
2. Log in to your domain provider (e.g., GoDaddy, Cloudflare) and paste the CNAME records into your DNS settings.
4. **Verify your setup**
1. After adding the records, return to Starshipit and click **Verify**.
2. Once verified, your emails will be protected by DKIM.
## Example CNAME Records
Here’s an example of what the CNAME records might look like:
| Type | Host | Value |
| --- | --- | --- |
| CNAME | ssi2825.yourdomain.com | u11952735.wl236.sendgrid.net |
| CNAME | ssi._domainkey.yourdomain.com | ssi.domainkey.u11952735.wl236.sendgrid.net |
| CNAME | ssi2._domainkey.yourdomain.com | ssi2.domainkey.u11952735.wl236.sendgrid.net |
---
# Configure SPF for email notifications
URL: https://support.starshipit.com/articles/360001215976-configure-spf-for-email-notifications
Canonical: https://support.starshipit.com/articles/360001215976-configure-spf-for-email-notifications
Markdown: https://support.starshipit.com/articles/360001215976-configure-spf-for-email-notifications.md
Updated: 2026-05-07
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Learn about Sender Policy Framework (SPF) and how to set it up for Starshipit email notifications.
## About Sender Policy Framework (SPF)
Sender Policy Framework (SPF) is an email authentication method designed to detect forged sender addresses during the delivery of email.
SPF allows the receiving mail server to check that a mail claiming to come from a specific domain is submitted by an IP address authorised by that domain's administrators. The list of authorised sending hosts and IP addresses for a domain is published in the DNS records for that domain.
## Why you would set up an SPF record
You can publish an SPF record for your domain (e.g. yourfantasticstore.com) to reduce the likelihood of spammers and phishers sending emails that pretend to be from your domain.
These kinds of forged emails are more likely to be caught by spam filters, who can check your SPF record. An SPF-protected domain is less likely to be blacklisted by spam filters, and legitimate emails from the domain are more likely to get through.
## SPF and sender authentication
If you have an SPF record set for your root domain, you must add **include:sendgrid.net** before the *all* mechanism of the record.
```
v=spf1 include:sendgrid.net ~all
```
For example, if your record looks like this:
```
v=spf1 include:_spf.google.com ~all
```
you'll need to add our lookup at the end of the string, before the *all* mechanism:
```
v=spf1 include:_spf.google.com include:sendgrid.net ~all
```
---
# Set up Kudosity
URL: https://support.starshipit.com/articles/9866978709903-set-up-kudosity
Canonical: https://support.starshipit.com/articles/9866978709903-set-up-kudosity
Markdown: https://support.starshipit.com/articles/9866978709903-set-up-kudosity.md
Updated: 2026-05-07
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Step-by-step guide to setting up Kudosity.
Kudosity (formerly Burst SMS) is the SMS provider used by Starshipit to send text messages. Integrate your Kudosity account with Starshipit to facilitate seamless SMS communication.
:::note
Migrating from Old SMS Billing Why are we shifting the SMS billing management and what are the benefits of migrating?SMS will be much cheaper for you You will gain access to built-in account top-up features like auto recharge, the same billing account across multiple SSI instances, and more visibility of SMS sent To switch over, sign up for Kudosity and enter in your API details in Starshipit. If these are entered, we will begin using your account.
:::
## Signing up for Kudosity
1. Go to [Kudosity registration page](https://kudosity.com/trial). You'll need an email and a valid phone number.
2. Once you finish signing up, navigate to Settings:
* Scroll to find the API key section.
* Enter a password for the API key and save it.
3. Visit the **Billing** page to add funds to your SMS account.
## Setting up SMS Notifications
1. Once you have your Kudosity account, navigate to **Settings** > **Tracking and Notifications** and scroll down to the Kudosity section.
2. Enter in your Kudosity API key and secret.
3. Click **Save**.
4. If you haven't already, configure your SMS notifications (i.e., what messages are sent and when) by following this [guide](/articles/notifications-branded-tracking-rules-child-accounts/notifications/customise-outbound-sms-notifications).
---
# Customise outbound SMS notifications
URL: https://support.starshipit.com/articles/115000906983-customise-outbound-sms-notifications
Canonical: https://support.starshipit.com/articles/115000906983-customise-outbound-sms-notifications
Markdown: https://support.starshipit.com/articles/115000906983-customise-outbound-sms-notifications.md
Updated: 2026-05-07
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Learn how to customise SMS notifications for outbound shipments in Starshipit.
:::warning
Notifications will not be sent for "Pickup In Store" and "Plain Label" orders when on a Trial Subscription due to spam protection measures.
:::
## Integrate your SMS account
To send SMS with Starshipit, you'll need a Kudosity account. For details on creating and integrating an account, check out our [support guide.](/articles/notifications-branded-tracking-rules-child-accounts/notifications/how-to-set-up-kudosity)
## Choose when to send delivery updates
Starshipit can manage an SMS template for each different delivery status and will trigger an SMS only for the checked status. For example, you can choose to send an email or SMS when an order label is printed to when the order is delivered.
1. In [Starshipit](https://app2.starshipit.com/), navigate to **Settings** > **Tracking and Notifications**.
2. Enable the checkbox for the delivery stages you want to notify a customer.
3. Click **Save**.
## Set your Sender ID
You can configure a sender ID if you'd like your SMS messages to come from your company name or number.
1. Ensure you've [set up the Sender ID in Kudosity](https://help.kudosity.com/s/article/44001076914-how-to-define-a-custom-sender-id?).
2. Go to **Settings** > **Tracking and Notifications** > **Custom Sender ID** and enter your Sender ID.
3. Click **Save.**
## Edit the SMS template
1. In [Starshipit](https://app2.starshipit.com/), navigate to **Settings** > **Tracking and Notifications**.
2. Click on **SMS Template** for the delivery stage you want to edit.
3. From the editor, you can modify the SMS template as required.
4. Click **Save**.
## Use the Starshipit variable
Use Starshipit variables to personalise your email and include information about the order.
### Variables:
* **Recipient** **Name**: Name of your customer
* **Our Ref**: Sender's reference (e.g. sales order number)
* **Their Ref**: Receiver's reference (e.g. purchase order number)
* **Courier Name**: The courier used to ship the parcel.
* **Tracking Number**: Tracking number associated with the parcel
* **Tracking URL**: Tracking URL associated with the parcel
* **Company Name**: Your company name
* **Telephone**: Your contact number
## Important Information
The maximum character limit for SMS notifications is 160. If you exceed this limit, the notification will be treated as two or more text messages. If you include an Emoji your text message character limit is reduced from 160 to 70 per SMS.
Many eCommerce platforms (including **Shopify** and **Magento**) include notification options which email customers when the status of an order is updated. If you have opted to write back the status to your eCommerce platform, you may need to consider whether your customers are receiving duplicate notifications and then enable/disable notifications, as required.
---
# Send tracking updates with webhooks
URL: https://support.starshipit.com/articles/360000376436-send-tracking-updates-with-webhooks
Canonical: https://support.starshipit.com/articles/360000376436-send-tracking-updates-with-webhooks
Markdown: https://support.starshipit.com/articles/360000376436-send-tracking-updates-with-webhooks.md
Updated: 2026-05-07
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Learn how to set up webhook notifications in Starshipit to receive tracking updates in your own applications.
## How it works
You can use the notification endpoint URL to receive our webhook data and trigger a certain event in your own application.
E.g. Send an order update email to your customer or update the order status in your database when 'OutForDelivery' tracking status is received.
The notification endpoint URL needs to be built to accept the POST request that returns HTTP 200 OK response and the URL can be set in [Starshipit](https://app2.starshipit.com/) > **Settings** > **Tracking & notifications**.
## Webhook JSON Data Definitions
| Name | Data Type | Description |
| --- | --- | --- |
| ``` order_number ``` | string | The identifier of the order pulled from source e-Commerce platform |
| ``` carrier_name ``` | string | Name of the courier used for shipment delivery |
| ``` carrier_service ``` | string | Courier product service used for shipment delivery |
| ``` shipment_date ``` | datetime | The local date when the label was generated for the shipment |
| ``` tracking_number ``` | string | Courier tracking number |
| ``` tracking_status ``` | string | Last tracking status from the courier |
| ``` last_updated_date ``` | datetime | Last updated timestamp. For Printed/Manifested events, this is generated by Starshipit in UTC. For tracking events, this reflects the courier event time as reported by the courier and is not normalized to your display timezone. |
## Tracking Statuses
* Printed
* Dispatched
* InTransit
* OutForDelivery
* Delivered
* PickupInStore*
* AttemptedDelivery*
* Exception*
* AwaitingCollection*
* Cancelled*
* Manifested
* ReturnPickupPrinted
* ReturnDropoffPrinted
* DroppedOff
* ReturnLink
* ReturnLabel
*Not supported for return shipments
## Webhook POST Data Example
```
{
order_number:5567476,
carrier_name:Australia Post,
carrier_service:7B05,
shipment_date:2018-08-09T02:55:37.1446912Z,
tracking_number:QQQ001737901000931501,
tracking_status:Dispatched,
last_updated_date:2018-08-09T02:56:07.3453198Z
}
```
# (Optional) Securing Webhooks
You can secure webhooks by providing a secret key. Generate a secret key from this settings page or provide your own.
If a secret is specified, any webhooks received from Starshipit will include a **x-starshipit-signature** header containing a signature.
See the following examples for how this signature can be checked:
## Javascript Example
```
// JavaScript: Validate webhook signature using the Web Crypto API
async function validateWebhook(payload, headerSignature, secret) {
const encoder = new TextEncoder();
const keyData = encoder.encode(secret);
const payloadData = encoder.encode(payload);
// Import the secret key for HMAC-SHA256
const cryptoKey = await crypto.subtle.importKey(
"raw",
keyData,
{ name: "HMAC", hash: "SHA-256" },
false,
["sign"]
);
// Compute the HMAC signature of the payload
const signatureBuffer = await crypto.subtle.sign("HMAC", cryptoKey, payloadData);
const signatureArray = Array.from(new Uint8Array(signatureBuffer));
const computedSignature = signatureArray.map(b => b.toString(16).padStart(2, '0')).join('');
return computedSignature === headerSignature;
}
// Example usage:
const payload = JSON.stringify({ order_number: "12345", tracking_number: "ABC123"
});
const headerSignature = "your_header_signature_here"; // Replace with actual header signature
const secret = "your_shared_secret_here"; // Replace with your shared secret
validateWebhook(payload, headerSignature, secret)
.then(isValid => {
console.log(isValid ? "Valid webhook signature!" : "Invalid webhook signature.");
});
```
## Python Example
```
import hmac
import hashlib
import json
def validate_webhook(payload, header_signature, secret):
# Ensure payload is a JSON string. If payload is a dict, convert it.
if isinstance(payload, dict):
payload = json.dumps(payload, separators=(',', ':'))
# Compute HMAC-SHA256 signature
computed_signature = hmac.new(
secret.encode('utf-8'),
payload.encode('utf-8'),
hashlib.sha256
).hexdigest()
return computed_signature == header_signature
# Example usage:
payload = '{"order_number": "12345", "tracking_number": "ABC123"}'
header_signature = "your_header_signature_here" # Replace with actual header signature
secret = "your_shared_secret_here" # Replace with your shared secret
if validate_webhook(payload, header_signature, secret):
print("Valid webhook signature!")
else:
print("Invalid webhook signature.")
```
---
# Understand notifications and branded tracking
URL: https://support.starshipit.com/articles/115000906843-understand-notifications-and-branded-tracking
Canonical: https://support.starshipit.com/articles/115000906843-understand-notifications-and-branded-tracking
Markdown: https://support.starshipit.com/articles/115000906843-understand-notifications-and-branded-tracking.md
Updated: 2026-05-07
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Learn how to use Starshipit's notifications and branded tracking pages to keep customers updated on delivery status.
## Features
#### Basic
* Starshipit branded default tracking notifications and pages are available.
#### Advanced
* Customise your tracking notifications and pages such as text, images, logos, colours and more.
* Use Starshipit's notifications and branded tracking pages to keep your customers up to date on the status of their deliveries.
* Choose between either the classic notifications and branded tracking page templates or our new template settings, which feature richer customisation options.
* Use the Brand hub to manage all your brand assets from one place.
:::warning
Notifications will not be sent for "Pickup In Store" and "Plain Label" orders when on a Trial Subscription due to spam protection measures.
:::
## How it works
Use Starshipit's email and SMS editor to create branded emails and SMS messages in line with your company's brand and communication style.
Choose between either the classic notifications and branded tracking page templates or our new template settings, which feature richer customisation options.
Starshipit's branded tracking page will direct your customers to your website, not your courier's, so they can see the status of their delivery and create return labels (if you choose to enable this option).
You can opt-in or out to notify your customers via email or SMS alerts at seven different stages of the delivery process:
* Printed
* Manifested
* Picked-up
* In transit
* Out for delivery
* Delivered
* Pickup In Store
{{video:youtube:X_HHEbhBDyI}}
### **What's next?**
Learn how to customise notifications:
1. [Enable and configure the branded tracking page](/articles/notifications-branded-tracking-rules-child-accounts/branded-tracking/enable-and-configure-the-branded-tracking-page)
2. [Configure Brand Hub](/articles/6487872345359)
3. [Customise text notifications](/articles/notifications-branded-tracking-rules-child-accounts/notifications/customise-outbound-sms-notifications)
4. [Customise email notifications](/articles/notifications-branded-tracking-rules-child-accounts/notifications/set-up-email-notifications)
5. [Set up self-service return label generator](/articles/notifications-branded-tracking-rules-child-accounts/branded-tracking/set-up-self-service-return-label-generator)
---
# Enable and configure the branded tracking page
URL: https://support.starshipit.com/articles/115000827566-enable-and-configure-the-branded-tracking-page
Canonical: https://support.starshipit.com/articles/115000827566-enable-and-configure-the-branded-tracking-page
Markdown: https://support.starshipit.com/articles/115000827566-enable-and-configure-the-branded-tracking-page.md
Updated: 2026-05-07
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Learn how to enable and configure the branded tracking page in Starshipit for a better post-purchase customer experience.
{{video:youtube:aBp-IizMr0k}}
## Features
#### Basic
* Default tracking notifications and pages with Starshipit watermarks.
#### Advanced
* Customise your tracking notifications and pages such as:
+ Text
+ Images
+ Logos
+ Colours
### What’s the difference between classic branded tracking and new branded tracking?
New branded tracking features more customisation options than classic branded tracking, as well as the ability to create a richer post-purchase experience by including things like notices, disabling the tracking bubbles (if required), and adding promotion blocks and contact information.
## Enable branded tracking
To enable either classic or new branded tracking, you first need to enable the branded tracking feature. Depending on the option you choose, customers will receive either the default courier page or a custom page which you can customise.
* In Starshipit, navigate to **Settings** > **Tracking and Notifications**
* You’ll see two checkboxes:
+ New tracking page template
+ Classic tracking page template
Here’s what these options mean:
* When no options are selected, tracking links included in customer notification emails will send customers to the couriers tracking page.
* When **New tracking page template** is selected, tracking links included in customer notification emails will send customers to the page configured on the new branded tracking page.
* When **Classic tracking page template** is selected, tracking links included in customer notification emails will send customers to classic tracking page.
## New branded tracking
If you have the Advanced add-on, you can customise your logo, colours and other settings using the Brand hub page under Settings.
1. To edit the template, click the blue hyperlink **New tracking page template**.
2. Set your page title
* Write your page title in the field provided.
### Display a notice banner
Need to make an announcement to your customers regarding shipping or handling? Use the optional notices section. This displays across branded tracking, customer notifications, and returns.
1. Click **Enable notice section** to turn the notice banner on.
2. Write your notice in the field provided.
### Turn tracking bubbles on or off
Choose to show or hide the tracking status bubbles from your branded tracking page.
* Tracking bubbles are enabled by default. Click **Enable tracking bubbles** if you want to turn tracking bubbles off.
### Add your contact information
List relevant ways customers can contact you if they have a question or require support post purchase. Contact information is an optional section displayed across branded tracking, customer notifications, and returns.
1. Click **Enable contact information**.
2. Add your **Section title** – The header for this contact block.
3. Add your **Text** – The name of the contact field (Email, support page etc.).
4. Add your **URL** – Where the contact section will link to.
5. Click **Add another** to add another contact section.
### Add promotion blocks
Add a promotional image to your branded tracking page and enter an image URL to direct customers to on click.
1. Click **Enable promotion blocks**.
2. Click **Select** to upload your image.
3. Enter your **URL** – where your image will link to when clicked.
### Customise your footer
Use the footer to include any important information or links.
1. Click **Enable footer section**.
2. Write your message or add URLs in the **Content field**.
3. Click **Enable Starshipit watermark** to remove the Starshipit watermark.
## Classic branded tracking
1. To edit the template, click the blue hyperlink **New tracking page template**.
2. Edit the page title and add your logo.
The page title is the title displayed on top of the browser or on the tab of your browser. You can edit the title and write your own brand name.
The Custom logo will be displayed on top of the page.
### Edit notice content
Just under the status progression bar, you can add some content. This content can include images, text, and everything that our HTML editor can generate.
### Edit the footer
You can edit the footer of the page. The footer can include images, text, and everything that our HTML editor can generate.
---
# Configure Brand Hub
URL: https://support.starshipit.com/articles/6487872345359-configure-brand-hub
Canonical: https://support.starshipit.com/articles/6487872345359-configure-brand-hub
Markdown: https://support.starshipit.com/articles/6487872345359-configure-brand-hub.md
Updated: 2026-05-07
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Learn how to use the Brand Hub to manage all your brand assets for customer notifications and branded tracking pages.
Use Brand Hub to manage the store details, brand assets, colours, and social links shown in customer notifications and on your branded tracking page.
## How it works
The Brand hub allows users customise the following items:
* [Store details (name and URL)](#store-details)
* [Brand assets (logo, alignment and favicon)](#brand-assets)
* [Brand colours](#brand-colours)
* [Social media links](#social-media-links)
You can access the Brand hub by going to **Starshipit** > **Settings** > **Brand hub**.
### Store details
Change your store name and store URL using these fields. The Store URL will link the logo to the provided URL.
### Brand assets
Upload and manage brand assets, which appear on your shipping notifications and branded tracking page.
You can upload your logo and choose how it aligns, and upload a favicon.
### Brand colours
Use this section to manage the colour scheme used across the post purchase experience, including customer notifications and your branded tracking page. To change a colour, click the bubble or enter the colour code directly.
### Social media links
Add and manage the social links shown across your post purchase experience. If you leave a field empty, the icon will not be displayed.
You can choose to show or hide social links for each part of the post-purchase experience using **Display options**.
---
# Check how often tracking updates
URL: https://support.starshipit.com/articles/360000136135-check-how-often-tracking-updates
Canonical: https://support.starshipit.com/articles/360000136135-check-how-often-tracking-updates
Markdown: https://support.starshipit.com/articles/360000136135-check-how-often-tracking-updates.md
Updated: 2026-05-07
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Learn how often tracking updates are imported from couriers to Starshipit.
## How it works
Starshipit automatically imports the latest delivery events from most of our couriers. However, there is a limit on the frequency for when Starshipit can check for new tracking updates per order, often imposed by the courier companies themselves.
Below is a table that outlines the two update frequencies, by carrier. Starshipit can check for updates more frequently if we also send out branded email and/or SMS notifications.
| Carrier | Frequency w/o notifications enabled | Frequency w/ notifications enabled | Tracking Data (how far back we check) |
| --- | --- | --- | --- |
| Australia Post | 8 hours | 3 hours | 15 days |
| Australia Post onDemand | Not implemented | Not implemented | N/A |
| CourierPost | 8 hours | 3 hours | 15 days |
| CouriersPlease | 8 hours | 3 hours | 15 days |
| Deutsche Post | 8 hours | 3 hours | 15 days |
| DHL eCommerce Asia Pacific | 8 hours | 3 hours | 15 days |
| DHL Express | 8 hours | 3 hours | 15 days |
| DHL Parcel Europe | 8 hours | 3 hours | 15 days |
| DHL Parcel UK | 8 hours | 3 hours | 15 days |
| DPD Local UK | 8 hours | 3 hours | 15 days |
| DPD NL | 8 hours | 3 hours | 15 days |
| DPD UK | 8 hours | 3 hours | 15 days |
| Fastway | 8 hours | 3 hours | 15 days |
| FedEx | 8 hours | 3 hours | 15 days |
| Hunter Express | Not implemented | Not implemented | N/A |
| NZ Couriers | 8 hours | 3 hours | 15 days |
| NZ Post | 8 hours | Instant | 15 days |
| Pace | 8 hours | 3 hours | 15 days |
| Quantium Solutions AU | 8 hours | 3 hours | 15 days |
| Quantium Solutions NZ | 8 hours | 3 hours | 15 days |
| Rendr | 8 hours | 3 hours | 15 days |
| Royal Mail | Not implemented | Not implemented | N/A |
| Seko Logistics | 8 hours | 3 hours | 15 days |
| Sendle | 8 hours | 3 hours | 15 days |
| Singapore Post | 8 hours | 3 hours | 15 days |
| StarTrack | 8 hours | 3 hours | 15 days |
| TNT | 8 hours | 3 hours | 15 days |
| Team Global Express IPEC | Not implemented | Not implemented | N/A |
| Team Global Express Priority | 8 hours | 3 hours | 15 days |
| Uber | 8 hours | 3 hours | 15 days |
| UPS | 8 hours | 3 hours | 15 days |
| Zoom2u | 8 hours | 3 hours | 15 days |
---
# Track Starshipit orders in Zendesk
URL: https://support.starshipit.com/articles/6988095852431-track-starshipit-orders-in-zendesk
Canonical: https://support.starshipit.com/articles/6988095852431-track-starshipit-orders-in-zendesk
Markdown: https://support.starshipit.com/articles/6988095852431-track-starshipit-orders-in-zendesk.md
Updated: 2026-05-07
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Learn how to install and use the Starshipit Order Tracker app to search for tracking information within Zendesk.
{{video:youtube:S6x1b8GX21s}}
## Installation Steps
1. Find **Starshipit Order Tracker** on the [Zendesk Marketplace](https://www.zendesk.com/marketplace/apps/support/950431/starshipit-order-tracker/).
2. Click the **Install** button.
3. Select the account which you’d like to use the Starshipit Order Tracker with.
4. Open a separate browser window and log in to your Starshipit account:
* If you already have a Starshipit account, log in using your credentials.
* If you don't have an account yet, sign up for a free account to get started.
5. Retrieve your [API key](/articles/integrations/the-starshipit-api/how-to-find-your-starshipit-api-key) and Subscription key from Starshipit.
* Once you’re logged in to Starshipit, navigate to your account settings and retrieve your subscription and API key.
* Copy your API key and Subscription key to Zendesk.
6. In the Zendesk installation page, locate the fields for API key and Subscription key. Paste the keys that you retrieved from your Starshipit account.
7. Click **Save**.
## How it works
1. The app will show in the right side panel when you open the ticket
2. Search by either the order number or tracking number
3. Select **Check Delivery Status**
4. Relay the information to your customer.
---
# Track Starshipit orders with the Chrome extension
URL: https://support.starshipit.com/articles/9449585686415-track-starshipit-orders-with-the-chrome-extension
Canonical: https://support.starshipit.com/articles/9449585686415-track-starshipit-orders-with-the-chrome-extension
Markdown: https://support.starshipit.com/articles/9449585686415-track-starshipit-orders-with-the-chrome-extension.md
Updated: 2026-07-17
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Use our Chrome extension to lookup Starshipit tracking information from any web page.
{{video:youtube:T9ofzew8sVw}}
## How to get started
1. Install the [extension](https://chromewebstore.google.com/detail/ssi-order-lookup-extensio/hecdddiacohpnjckpnpcmghbplfjkcco?hl=en-GB&authuser=0) to your Chrome browser.
2. Right-click on the extension icon and go to **Options**, or open the extension and click the Settings cog. This will take you to the settings page for the extension.
3. You will need to enter your Starshipit API Key and Subscription Key. There is a link in the page that will lead you to the Starshipit API settings page. Copy these details across and save them in the extension settings page.
4. You're now setup and ready to use the extension.
You can now look up Starshipit tracking information from any web page.
## Search by phrase and include child accounts
You can also search by phrase and include child accounts in your search by using the tick box beneath the Order Number field.
## Supported web browsers
You can use Starshipit Chrome extensions in either **Google Chrome** or **Microsoft Edge**. To install the extensions in Microsoft Edge, simply head to the Chrome Web Store (instead of the Edge Add-ons website).
---
# Returns with Starshipit
URL: https://support.starshipit.com/articles/212423546-returns-with-starshipit
Canonical: https://support.starshipit.com/articles/212423546-returns-with-starshipit
Markdown: https://support.starshipit.com/articles/212423546-returns-with-starshipit.md
Updated: 2026-05-07
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Learn how to set up and process returns with Starshipit, including manual labels, returns from existing orders, and automated return labels.
Starshipit offers four ways to handle returns. Choose the option that fits your workflow — from a fully automated self-service portal to manual one-off labels.
## Option 1: Self-service branded returns portal
Let customers generate their own return labels through a branded portal on your domain. This is the most automated option and requires the Returns add-on.
This feature is available as an add-on for an additional $20 per month for Starter and Professional plans. Learn how to [set up a branded returns portal](/articles/returns/branded-returns-portal/set-up-branded-returns-portal).
## Option 2: Create a return label manually
1. In Starshipit, navigate to **Orders**.
2. In the top right, click **Create order**, then select **Create a return order**.
* The sender address (i.e. the warehouse) is where the shipment is being returned to.
* The receiver address (i.e. the address of the customer) is the address the product is being sent from.
3. Fill in the required fields and choose the courier service.
4. Print or email the label.
## Option 3: Print a return label from an existing order
1. In Starshipit, navigate to **Orders**, then select the **Shipped** tab.
2. Open the order that you want to create a return label for.
3. Click **Create a return order**, then click to confirm.
4. You will be taken to a page with the return shipment details. You can download, email, or print the label from here.
## Option 4: Automate return labels with each outgoing shipment
Automatically create a return shipment with each outgoing shipment you process through Starshipit.
:::note
Once an order is printed or shipped, it cannot be edited. Refund payments must be handled separately from the Starshipit return portal.
:::
### Using the same courier
1. Go to **Settings**, then select **Rules**.
2. Click **Add a new rule**.
3. Set up the rule for your matching condition (e.g. All Orders) and the action **Create Return** > **True**.
4. Click **Run Rules Now** or [re-import your orders](/articles/orders-manifests-reports/faqs/how-to-remove-re-import-orders) so the create return flag is applied against existing orders.
When you print new orders, a matching return label will be generated alongside each one.
### Using a specified courier
1. Go to **Settings** > **Rules**.
2. Click **Add a new rule**.
3. Set up the rule to for your matching condition (e.g. All Orders) and the action **Create Return For Specified Courier**.
4. For the value, select the courier and service code you would like to use. You can see a list of service codes under each courier's settings in **Settings** > **Couriers**.
5. Click **Run rules now** or [re-import your orders](/articles/orders-manifests-reports/faqs/how-to-remove-re-import-orders) so the create return flag is applied against existing orders.
When you print new orders, a return label using the specified courier will be generated alongside each one.
## Which carriers support returns?
* Aramex — only supported for creating a return from an existing order
* Australia Post eParcel — pickup services are not supported
* Castle Parcels
* CouriersPlease
* DHL Express
* FedEx — only supported for creating a return from an existing order
* NZ Couriers
* NZ Post Domestic
* NZ Post International — only supported for returns from AU to NZ
* Plain Labels
* Post Haste
* StarTrack
* TNT
* UPS
* USPS
## Set up returns for your courier
Speak with your courier account manager first to discuss pricing, the lodgement process, and their recommendations. Some couriers require additional setup with the courier directly or within Starshipit:
* [Set up returns with Australia Post eParcel](/articles/couriers/australia-post/set-up-australia-post-eparcel-returns)
* [Set up returns with CouriersPlease](/articles/couriers/couriersplease/how-to-set-up-couriersplease)
* [Set up returns with NZ Post Domestic](/articles/couriers/nz-post/how-to-set-up-nz-post-domestic)
* [Set up returns with UPS](/articles/couriers/ups/how-to-set-up-ups#h_01J7HG87W1HCX9JB5RWAZKQDC0)
---
# Understand the benefits of a branded returns portal
URL: https://support.starshipit.com/articles/4414146200975-understand-the-benefits-of-a-branded-returns-portal
Canonical: https://support.starshipit.com/articles/4414146200975-understand-the-benefits-of-a-branded-returns-portal
Markdown: https://support.starshipit.com/articles/4414146200975-understand-the-benefits-of-a-branded-returns-portal.md
Updated: 2026-02-04
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Learn how the Branded Returns Portal can increase sales, reduce support queries, and improve customer experience.
A transparent and easy returns process increases cart conversion and keeps customers coming back. Here's why a self-service returns portal is the best solution for return management:
| Benefit | Description |
|---------|-------------|
| **Increase sales** | A transparent, easy returns process increases cart conversion and keeps customers coming back by allowing them to shop with confidence. |
| **Reduce support queries** | A self-service returns process reduces inbound customer service queries, saving time and money that your team can reinvest into other areas of the business. |
| **Manage costs** | Offer different services and couriers for your returns and change them at the click of a button to keep return shipment costs in check. |
| **Insights & data** | Track why customers return items to identify common trends or insights on why particular SKUs might be returned. |
| **Improve customer experience** | Customers expect to easily arrange a return without contacting your support team. A self-service portal empowers customers and improves their experience. |
| **Sustainability** | No need to print a return label with every shipment – labels are only generated when needed, reducing waste. |
---
# Explore branded returns portal features
URL: https://support.starshipit.com/articles/4414146377487-explore-branded-returns-portal-features
Canonical: https://support.starshipit.com/articles/4414146377487-explore-branded-returns-portal-features
Markdown: https://support.starshipit.com/articles/4414146377487-explore-branded-returns-portal-features.md
Updated: 2026-02-04
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Explore the features of the Branded Returns Portal including customisation, rules engine, reimbursement options, and carrier support.
The returns portal is a feature-rich solution that enables you to automate your returns policy in a way that is easy for both your team to manage and your customers to enjoy.
## Portal customisation
- Customise the portal to suit your brand and theming, including the page title, favicon, header and footer, accent colour, logo and packaging details
- Embed the portal onto your website to create a seamless experience for customers
- Customise the URL so that it matches your store with a subdomain
## Returns policy automation
- Use the in-depth rules engine to ensure your portal mirrors your returns policy (e.g. rejecting returns older than 30 days or rejecting certain SKUs like earrings)
- Set up multiple reimbursement options: store credit, refund from original payment, and exchanging products
- Charge freight costs based on the reimbursement option (e.g. refunds cost $5 but store credit is free to encourage customers to stay in your ecosystem)
## Customer communication
- Send branded emails and SMS notifications throughout the returns process to keep yourself and your customer informed
- Send customised return links directly from your outgoing orders in Starshipit
- Send customers a shipping label directly
## Carrier support
Enable a range of supported carriers including:
- DHL
- Australia Post
- TNT
- CourierPlease
- NZ Post
- More being added regularly
## Order management
- Automatically creates a return based on the outgoing order (down to the dimensions and items included in the shipment)
- Create partial and multiple returns for a single order
- Allow customers (or your team) to reprint a return label if it's misplaced
- Let customers edit their return address to ship from a different location than where they originally received the parcel
---
# Set up branded returns portal
URL: https://support.starshipit.com/articles/4414146875279-set-up-branded-returns-portal
Canonical: https://support.starshipit.com/articles/4414146875279-set-up-branded-returns-portal
Markdown: https://support.starshipit.com/articles/4414146875279-set-up-branded-returns-portal.md
Updated: 2026-06-14
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Set up a branded self-service returns portal and generate the customer-facing returns URL.
Set up a branded self-service returns portal so customers can submit return requests based on your returns policy.
## Before you begin
Make sure you have:
- Access to **Manage account** in Starshipit.
- Returns courier configuration in your account.
- Returns policy and terms ready for your portal content.
:::warning
For Starter and Professional plans, Advanced Returns is a paid add-on. Enabling this feature can affect your billing.
:::
## Add Advanced Returns to your account
1. Click the **account name drop-down** in the top right corner of the dashboard.
2. Click **Manage account**.
3. Scroll to **Manage Add-ons**.
4. Tick **Advanced Returns**.
5. Click **Save**.
After saving, Advanced Returns is enabled for your account.
## Enable the returns portal
1. Go to **Settings > Returns**.
2. Tick **Enable**.
3. Optional: Enter a subdomain to customise the returns portal URL.
4. Click **Save**.
When **Enable** is ticked and saved, your returns portal is active and Starshipit generates a unique portal URL.
For example, if your subdomain is `BobsBuildings`, the portal URL is `bobsbuildings.returns.starshipit.com`.
## Configure return couriers
If you have not used Starshipit for returns before, configure courier accounts for return shipments before customers start submitting returns.
For return label setup, see [Returns with Starshipit](/articles/212423546-returns-with-starshipit).
## Configure child accounts
Return addresses and returns rules must be set up at child-account level. Parent account configuration does not automatically apply to child accounts.
:::important
For child accounts, create or select pickup addresses in **Settings > Pickup Address > Multiple shipping locations** and configure return rules in **Settings > Returns > Rules**.
:::
## Verify the portal
1. Open the generated returns portal URL.
2. Check that the portal loads with your account details.
3. Submit a test return that matches your policy.
4. Confirm the return appears in Starshipit and uses the expected courier settings.
## Customise the portal
After the portal is active, configure the content, rules, branding, notifications, and display method that match your returns policy.
## Related articles
- [Configure branded returns portal rules](/articles/90200000000133-configure-branded-returns-portal-rules)
- [Customise branded returns portal branding and notifications](/articles/90200000000134-customise-branded-returns-portal-branding-and-notifications)
- [Configure branded returns charges and validation](/articles/90200000000135-configure-branded-returns-charges-and-validation)
- [Display the branded returns portal to customers](/articles/90200000000136-display-the-branded-returns-portal-to-customers)
- [Returns with Starshipit FAQs](/articles/4414370792591-returns-with-starshipit-faqs)
---
# Set up the self-service return label generator
URL: https://support.starshipit.com/articles/115000906863-set-up-the-self-service-return-label-generator
Canonical: https://support.starshipit.com/articles/115000906863-set-up-the-self-service-return-label-generator
Markdown: https://support.starshipit.com/articles/115000906863-set-up-the-self-service-return-label-generator.md
Updated: 2026-05-07
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Step-by-step guide to setting up self-service return label generator.
:::note
This feature is not available on newer accounts
:::
## How it works
* On the branded tracking page you can give your customers the option to generate their own return labels (this is an optional setting within Starshipit).
* If the customer wishes to return a product to you, they can enter their email address and the reason why they want to return the product.
* An email containing the return label will be sent both to the customer as well as the owner of the account. The customer will have to print the label to return the product, but you can also start a dialogue with the customer through that email.
:::note
Return labels are available for DHL Express & Australia Post Domestic.
:::
## 1. Activate the Branded Tracking Page
1. In [Starshipit](https://app2.starshipit.com/), go to **Settings** > **Tracking and notifications**.
2. Tick **Classic tracking page template.**
3. Click Save at the bottom of the page.
4. Click on **Classic tracking page template** for the next step.
## 2. Enable return shipping label generation
1. Select Customise your own**.**
2. Scroll to the bottom of the customisation page and select **Enable Return Shipping Label Generation.**
3. Click **Save**.
---
# Configure branded returns portal rules
URL: https://support.starshipit.com/articles/90200000000133-configure-branded-returns-portal-rules
Canonical: https://support.starshipit.com/articles/90200000000133-configure-branded-returns-portal-rules
Markdown: https://support.starshipit.com/articles/90200000000133-configure-branded-returns-portal-rules.md
Updated: 2026-06-15
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Configure branded returns portal terms, return reasons, return options, and rules.
Configure branded returns portal rules so customers can only submit return requests that match your returns policy.
## Before you begin
Prepare your returns policy, terms and conditions, return reasons, and the return options you want customers to choose from.
## Add terms and conditions
1. Go to **Settings > Returns > Terms & Conditions**.
2. Tick **Enable Terms & Conditions**.
3. Add your terms and conditions to the template editor.
4. Click **Save**.
After saving, your terms and conditions display in the returns portal.
## Configure returns rules
Use returns rules to block or adjust return requests based on your policy.
Common rules include:
- Accept returns only within 30 days of the order date.
- Block returns for specific SKUs, such as swimwear.
- Allow self-service returns only for domestic orders.
- Use a specific carrier for returns from a specific region.
- Mark returns containing specific items as dangerous goods.
1. Go to **Settings > Returns > Rules**.
2. Select **Add a new rule**.
3. Set the conditions.
4. Set the action.
5. Set the value, if the action needs one.
6. Click **Save**.
After saving, new returns are evaluated against your configured rules.
## Available rule conditions
| Condition group | Examples |
| --- | --- |
| Sender details | Sender contact name, country, country code, postcode, state, suburb or city, street, building, company. |
| Item details | Item SKU, item quantity, total item quantity, item country of manufacture, line item value. |
| Order details | All orders, order created date, order status, order value, order weight, order number, integration, store identifier, tags, their reference. |
| Shipping details | Shipping method, shipping description, PO Box and Parcel Locker orders. |
## Available rule actions
| Action | What it does |
| --- | --- |
| **Set Authority To Leave** | Allows couriers to leave parcels at the delivery location without a signature. |
| **Set Courier & Product Code** | Assigns a specific courier and product code. |
| **Set Contain Battery** | Flags orders that contain batteries as dangerous goods. |
| **Set Signature Required** | Requires a signature on delivery. |
| **Set Return Address** | Uses a specific address as the return address. |
| **Reject Returns** | Prevents certain items or orders from being returned. |
| **Set Return Cost** | Sets the cost associated with returning an item. |
| **Assign Tags** | Adds tags to the order for categorisation or reporting. |
## Configure return reasons
1. Go to **Settings > Returns > Settings > Returns reason**.
2. Enter each return reason on a new line.
3. Click **Save**.
After saving, customers must choose one of your configured reasons when submitting a return.
## Configure return options
1. Go to **Settings > Returns > Settings > Return Options**.
2. Select the options you want to enable:
- **Refund to store credit**
- **Exchange Product**
- **Refund to the original payment method**
3. Click **Save**.
After saving, only your selected return options are available in the portal.
## Related articles
- [Set up branded returns portal](/articles/4414146875279-set-up-branded-returns-portal)
- [Configure branded returns charges and validation](/articles/90200000000135-configure-branded-returns-charges-and-validation)
- [Returns with Starshipit FAQs](/articles/4414370792591-returns-with-starshipit-faqs)
---
# Customise branded returns portal branding and notifications
URL: https://support.starshipit.com/articles/90200000000134-customise-branded-returns-portal-branding-and-notifications
Canonical: https://support.starshipit.com/articles/90200000000134-customise-branded-returns-portal-branding-and-notifications
Markdown: https://support.starshipit.com/articles/90200000000134-customise-branded-returns-portal-branding-and-notifications.md
Updated: 2026-06-15
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Customise branded returns portal branding, portal content, and return notifications.
Customise your branded returns portal so the customer-facing returns experience matches your store and communication style.
## Customise portal branding
You can customise these parts of the returns portal:
- Logo
- Header and accent colour
- Page title and favicon
- Footer section
- Additional packaging details
## Update portal branding
1. Go to **Settings > Returns > Settings > Customise your return portal**.
2. Enable the sections you want to display in the returns portal.
3. Upload the relevant images.
4. Add the text you want customers to see.
5. Click **Save**.
Starshipit uses a rich text editor for portal templates. You can switch to HTML view if you need to copy existing code from your website.
## Customise returns notifications
Returns notifications let you control customer communication throughout the returns process.
1. Go to **Settings > Returns > Notifications**.
2. Select the SMS or email notifications you want to enable.
3. Select the email or SMS template you want to customise.
4. Edit the template.
5. Click **Save**.
## Available return notifications
| Notification | Trigger |
| --- | --- |
| **Send Return Link** | Sent when you send a customer a link to the returns portal. |
| **Return Pick Up Submitted** | Sent when the return is submitted. |
| **Return Parcel Picked Up** | Sent when the carrier records a pickup event. |
| **Return Received** | Sent when the carrier records a delivered event. |
| **Send Return Label** | Sent when you send a return label to a customer directly. |
## Related articles
- [Set up branded returns portal](/articles/4414146875279-set-up-branded-returns-portal)
- [Customise return email notifications](/articles/4415557120399-customise-return-email-notifications)
- [Customise return SMS notifications](/articles/4415548150031-customise-return-sms-notifications)
- [Display the branded returns portal to customers](/articles/90200000000136-display-the-branded-returns-portal-to-customers)
---
# Configure branded returns charges and validation
URL: https://support.starshipit.com/articles/90200000000135-configure-branded-returns-charges-and-validation
Canonical: https://support.starshipit.com/articles/90200000000135-configure-branded-returns-charges-and-validation
Markdown: https://support.starshipit.com/articles/90200000000135-configure-branded-returns-charges-and-validation.md
Updated: 2026-06-15
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Configure return charges and order-reference validation for the branded returns portal.
Configure return charges and order-reference validation when your branded returns portal needs extra control over customer return submissions.
## Return reimbursement
Starshipit does not charge customers for returns through the returns portal. If you need to recover return costs, deduct the amount from the refund or charge the customer externally through your payment gateway.
You can configure flat-rate charges based on the refund option selected in the portal.
## Configure return charges
1. Go to **Settings > Returns > Return Charges > Return Option**.
2. Configure the conditions and charges based on return option, origin location, and weight.
3. Click **Save**.
After saving, return charges are applied based on the configured option, destination, and weight conditions.
For table-rate setup patterns, see [Set up Table Rates](/articles/4414357709071-set-up-table-rates).
## Validate returns by order reference
You can let customers search for and submit returns using **TheirRef**, which is the receiver reference. This is useful if you import external order numbers and share those numbers with customers.
1. Go to **Settings > Returns**.
2. In the **Return Validation** section, tick **Validate returns based on order reference**.
3. Click **Save**.
When this setting is enabled, customers can submit returns using order reference. When it is disabled, order-reference validation is not available.
## Verify charges and validation
Submit a test return using the relevant return option, destination, weight, and order reference. Confirm the return is accepted or rejected as expected and that the correct charge is applied.
## Related articles
- [Set up branded returns portal](/articles/4414146875279-set-up-branded-returns-portal)
- [Configure branded returns portal rules](/articles/90200000000133-configure-branded-returns-portal-rules)
- [Returns with Starshipit FAQs](/articles/4414370792591-returns-with-starshipit-faqs)
---
# Customise return email notifications
URL: https://support.starshipit.com/articles/4415557120399-customise-return-email-notifications
Canonical: https://support.starshipit.com/articles/4415557120399-customise-return-email-notifications
Markdown: https://support.starshipit.com/articles/4415557120399-customise-return-email-notifications.md
Updated: 2026-05-07
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Learn how to customise return email notifications in Starshipit to enhance your customers' returns experience.
## Enable the emails that are right for you
Starshipit can manage an email template for each different delivery status and part of the returns process.
* **Send Return Link**Email used when sending customers a link to your returns portal
* **Return Pick Up Submitted**Email triggered when a customer books a courier to pick up a package
* **Return Parcel Picked Up**Email triggered when the carrier has scanned the package as picked up
* **Return Received**Email triggered when the carrier marks the shipment as delivered
* **Return Drop Off Submitted**Email triggered when a customer prints a label for dropping off to a post location
* **Received at Drop off Location**Emailed triggered when the courier scans the package as received at the drop off location
* **Send Return Label**Email used when sending a customer a return label direct from the Starshipit app
For example, you can choose to send an email when you have received the return to keep your customer informed.
1. In Starshipit, navigate to **Settings** > **Returns** > **Notifications**.
2. Enable the checkbox for the stages of delivery you want to notify a customer.
## Edit the email template
1. In Starshipit, navigate to **Settings** > **Customer Notifications/Tracking and notifications**.
2. Select an **Email Template**.
3. From the editor, you can modify the email template as required.
## Use the Starshipit variable
Use Starshipit variables to personalise your email and include information about the order. Starshipit variables can be included in the subject field and in an HTML tag (Track %OurRef% Online). They vary depending on which email template you are editing.
### Variables:
* **Sender Name:** Name of your customer returning the package
* **RMA or Return Reference**: Sender's reference (e.g. return order number)
* **Original Their Ref**: Receiver's reference (e.g. purchase order number)
* **Courier Name**: The courier used to ship the parcel.
* **Tracking Number**: Tracking number associated with the parcel
* **Tracking URL**: Tracking URL associated with the parcel
* **Company Name**: Your company name
* **Telephone**: Your contact number
* **Return Link:** Link to your returns portal
## Add an image in the email
1. From the email editor, select **Upload Image.**
2. Click **Upload**.
3. Select an image from your computer.
4. Click **Upload** from the dialogue box.
5. Select the image on the middle part of the screen.
6. Click **Insert**.
## Receiving email notifications as the receiver
You may want to set your account so that you are notified at any of the above seven stages. For example, you may want to keep track of when returns have been lodged. Starshipit allows you to add an email as BCC. This means you will receive a copy of the email to your chosen address.
1. Go to **Settings** > **Returns** > **Notifications**.
2. Select **Email Template** next to the email you would like a copy of.
3. Enter the address you would like the return emails to go to in the **BCC field**.
---
# Customise return SMS notifications
URL: https://support.starshipit.com/articles/4415548150031-customise-return-sms-notifications
Canonical: https://support.starshipit.com/articles/4415548150031-customise-return-sms-notifications
Markdown: https://support.starshipit.com/articles/4415548150031-customise-return-sms-notifications.md
Updated: 2026-05-07
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Learn how to customise SMS notifications for returns in Starshipit.
## Choose when to send delivery updates
Starshipit can manage an SMS template for each different delivery status and will trigger an SMS only for the checked status. For example, you can choose to send an email or SMS when a return is received by your warehouse
1. Go to **Settings** > **Returns** > **Notifications**.
2. Enable the checkbox for the stages of delivery you want to notify a customer.
## Edit the SMS template
1. Go to **Settings**, then select **Customer Notifications**.
2. Select an **SMS Template**.
3. From the editor, you can modify the SMS template as required.
## Use the Starshipit variable
Use Starshipit variables to personalise your email and include information about the order.
### Variables:
* **Sender Name:** Name of your customer returning the package
* **RMA or Return Reference**: Sender's reference (e.g. return order number)
* **Original Their Ref**: Receiver's reference (e.g. purchase order number)
* **Courier Name**: The courier used to ship the parcel.
* **Tracking Number**: Tracking number associated with the parcel
* **Tracking URL**: Tracking URL associated with the parcel
* **Company Name**: Your company name
* **Telephone**: Your contact number
* **Return Link:** Link to your returns portal
## Activate your SMS account
1. Go to **Settings** > **My Account** > **SMS**
2. Enter your credit card details and **Save**.
3. Enter a credit amount and click **Add Credit**.
SMS' will be sent until the credit balance reaches zero. You will receive a notification at the top of Starshipit before/when this happens.
## Important Information
The maximum character limit for SMS notifications is 160. If you exceed this limit, the notification will be treated as two or more text messages. If you include an Emoji your text message character limit is reduced from 160 to 70 per SMS.
---
# Display the branded returns portal to customers
URL: https://support.starshipit.com/articles/90200000000136-display-the-branded-returns-portal-to-customers
Canonical: https://support.starshipit.com/articles/90200000000136-display-the-branded-returns-portal-to-customers
Markdown: https://support.starshipit.com/articles/90200000000136-display-the-branded-returns-portal-to-customers.md
Updated: 2026-06-15
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Choose whether to embed the branded returns portal on your website or share the hosted portal URL.
Display the branded returns portal to customers by embedding it on your website or sharing the Starshipit-hosted portal URL.
## Choose a display method
| Method | Use when |
| --- | --- |
| Embedded iFrame | You want the portal to appear inside your website experience. |
| Hosted URL | You want a separate returns page managed by Starshipit, or you only want to share the portal with selected customers. |
## Embed the portal with an iFrame
An iFrame embeds the returns portal as inline HTML on an existing web page.
1. Go to **Settings > Returns > Settings > Get the code**.
2. Copy the code to your clipboard.
3. Open the website page where you want the returns portal to appear.
4. Edit the page HTML.
5. Paste the iFrame code.
6. Save or publish the page.
After setup, customers can access the returns portal directly from your website page.
## Share the hosted URL
After you enable the returns portal and optionally choose a subdomain, Starshipit gives you a unique portal URL.
You can include this URL in the **Send Return Link** email or share it directly with customers.
## Verify customer access
Open the embedded page or hosted URL in a private browser window. Check that the portal loads, uses your branding, and lets a customer start a test return.
## Related articles
- [Set up branded returns portal](/articles/4414146875279-set-up-branded-returns-portal)
- [Customise branded returns portal branding and notifications](/articles/90200000000134-customise-branded-returns-portal-branding-and-notifications)
- [Returns with Starshipit FAQs](/articles/4414370792591-returns-with-starshipit-faqs)
---
# Returns with Starshipit FAQs
URL: https://support.starshipit.com/articles/4414370792591-returns-with-starshipit-faqs
Canonical: https://support.starshipit.com/articles/4414370792591-returns-with-starshipit-faqs
Markdown: https://support.starshipit.com/articles/4414370792591-returns-with-starshipit-faqs.md
Updated: 2026-02-04
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Find answers to frequently asked questions about returns with Starshipit.
## What's included in each plan?
Every Starshipit plan includes a base set of returns features:
- Manually create return labels
- Print return labels from existing orders
- Create return labels with outgoing shipments
The **returns add-on** includes additional features:
- Create a customer-facing returns portal and embed it directly on your website
- Keep customers informed with SMS and email notifications
- Display multiple return payment options and set return charges for each option
- Let customers drop off their returns or arrange their own pick-ups
- Add your branding, colours, logos, content and links to your returns portal
- Create rules to reject returns for specific types of products
## FAQs
How much does the returns add-on cost?
The add-on is available for $20 monthly with Starter and Professional plans, while it is included in Enterprise plans. A 10-day free trial is offered with the add-on.
How do I set a default return courier?
When your customer begins the return process, they will be given a drop-down of what courier they would like to submit the return with. To customise which courier displays first:
1. Go to **Settings** > **Returns** > **Settings** > **Default courier**.
2. Select a default international courier and a default domestic courier.
3. Click **Save**.
Can returns be enabled on a child account?
Yes, returns can be enabled on a child account. When enabled they will be treated as an individual account.
Do return labels count against my regular allocation of shipping labels?
Yes. For example, if you are on our Starter Plus plan and issue 1,000 labels per month, and 100 of those are return labels, you'll have 900 labels left in total.
Which carriers does Starshipit support returns with?
Starshipit supports eCommerce returns with the following carriers:
- Aramex
- Australia Post eParcel
- Castle Parcels
- Couriers Please
- DHL Express
- FedEx (only supported for creating a return from an existing order)
- NZ Couriers
- NZ Post Domestic
- Plain Labels
- Post Haste
- StarTrack
- TNT
Can a customer create a partial return for the same order?
Yes, customers can create multiple returns on an order as long as the return quantity of each item doesn't exceed the original ordered quantity.
Can a customer use the returns portal for goods purchased in-store?
Yes, this is possible by manually creating an order and setting the status as **Delivered** in Starshipit:
1. Manually create an order using the customer's details.
2. Manually update the order status to **Delivered**.
3. Provide your customer with the return link, where they can initiate their return.
How do I refuse certain products from being returned?
Set up automation rules that reject returns based on certain criteria. For example, a return could be refused if the SKU includes "earrings". You can also add up to 10 varied reasons for returns options.
Can I offer both pickup and drop off return services?
Yes, Starshipit supports enabling both pickup and drop off for your returns portal. You cannot specify only one option.
Can a customer reprint their return label if they misplace it?
Yes, customers can re-download their shipping labels:
1. Go back to the return portal.
2. Re-enter their order details.
3. If there is a previously created return, they'll see an option to view and reprint the label.
Who pays for returns?
Returns are charged against your existing courier account.
Can a returnee print labels for multiple boxes?
Yes, customers can add additional packages to returns when they process a return using the returns portal.
What carriers allow pickups to be scheduled in the returns portal?
| Carrier | Pickup | Drop off |
|---------|--------|----------|
| NZ Post Domestic | ✓ | ✓ |
| Australia Post eParcel | ✗ | ✓ |
| Couriers Please | ✓ | ✗ |
| TNT | ✓ | ✗ |
| DHL Express | ✓ | ✗ |
Can TNT bring the return label when collecting the parcel?
Yes, if TNT eReturns is enabled for your account. With TNT eReturns, the customer does not need to print a return label before pickup. TNT brings the label when they collect the parcel.
Before using this workflow, confirm with TNT and Starshipit support that TNT eReturns is enabled on your account and that TNT is set up as a returns courier in Starshipit.
Do you support return writeback to eCommerce platforms?
No, we don't support this at this time.
Can you stop and start a free trial?
No, you cannot stop and then resume a free trial of the returns portal/advanced returns add-on.
---
# Get started with international shipping
URL: https://support.starshipit.com/articles/90200000000402-get-started-with-international-shipping
Canonical: https://support.starshipit.com/articles/90200000000402-get-started-with-international-shipping
Markdown: https://support.starshipit.com/articles/90200000000402-get-started-with-international-shipping.md
Updated: 2026-07-30
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Prepare the customs, product, tax, and delivery information needed before shipping an international order.
International shipments need complete product, customs, and tax information before you print a label. Use this checklist to prepare an order and reduce avoidable customs delays.
## Before you begin
- Confirm your courier and service support the destination and the goods you are sending.
- Check destination restrictions with your courier or the relevant customs authority.
- Confirm which tax registrations and delivery terms apply to your business. Starshipit cannot provide tax or customs advice.
## Prepare your international shipping data
1. Add an accurate description, value, weight, and quantity for every item.
2. [Set up HS codes](/articles/360002120496-set-up-hs-codes-for-international-shipments) so customs can classify the goods.
3. [Set the country of origin](/articles/360002751836-set-country-of-origin-for-international-shipments) for each item.
4. [Add shipper tax numbers](/articles/360002115215-set-up-shipper-tax-numbers) such as IOSS, EORI, VAT, or GST when required.
5. [Add receiver tax numbers](/articles/9133191385-receiver-tax-numbers) when the destination or courier requires them.
6. [Configure additional parties](/articles/360002115335-set-up-additional-parties-addresses) when the buyer, seller, importer, or exporter differs from the sender or receiver.
7. [Choose who pays duties and taxes](/articles/4415554835215-configuring-your-shipment-s-ddp-ddu) before selecting the delivery service.
8. Add any [additional shipping documents](/articles/4407149410703-add-additional-shipping-documentation-to-orders-document-manager) required by the courier or destination.
## Add an Export Declaration Number for high-value Australia Post shipments
For Australia Post international shipments sent from Australia, an Export Declaration Number (EDN) is required when the goods are valued at AUD $2,000 or more. An EDN is also required for goods that need an export permit, regardless of value. Australia Post does not issue the EDN; you or your authorised export agent must lodge the export declaration with the Australian Border Force first.
:::important
Do not enter an order number, Australia Post account number, or invoice number in **Export number**. Enter the EDN returned by the Australian Border Force or your authorised export agent.
:::
1. Confirm the total value of the items in the shipment and whether the goods need an export permit.
2. Lodge an export declaration with the [Australian Border Force](https://www.abf.gov.au/sdg-subsite/Pages/Exports-Overview.aspx), or ask your authorised export agent to lodge it for you.
3. Wait until you receive the EDN and its export status from the Australian Border Force or your agent.
4. Open the order in Starshipit and select the Australia Post international service.
5. In **Customs details**, enter the EDN in **Export number**.
6. Review the customs information, then print the label.
If the shipment is below AUD $2,000 and does not need an export permit, leave **Export number** blank unless Australia Post or your export agent tells you otherwise. For more detail, see [Australia Post's international customs guidance](https://auspost.com.au/business/shipping/parcels/international-sending/customs).
## Check the order before printing
Open the order and confirm the delivery address, item details, customs values, tax numbers, country of origin, and selected courier service. Resolve any missing or invalid details before you print the label.
If the shipment contains alcohol, batteries, aerosols, or another regulated product, review the [dangerous goods guidance](/articles/9865634439183-dangerous-goods-in-starshipit) and your courier's requirements before dispatching it.
---
# Set up HS codes for international shipments
URL: https://support.starshipit.com/articles/360002120496-set-up-hs-codes-for-international-shipments
Canonical: https://support.starshipit.com/articles/360002120496-set-up-hs-codes-for-international-shipments
Markdown: https://support.starshipit.com/articles/360002120496-set-up-hs-codes-for-international-shipments.md
Updated: 2026-02-18
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Step-by-step guide to setting up harmonised system (hs) codes for international shipments.
* HS Codes are used for international customs purposes to describe the type of items in a shipment using an indindustry-standard numbering system.
* Defining the correct HS Code helps to ensure the correct duties and taxes are applied by Customs.
* Learn about the various methods to add HS Codes to your items including importing them from your integrated platform, using rules, using a default option, or manual entry.
## Why are HS Codes important?
HS (Harmonised System) Codes are used by international shippers to help Customs identify the type of items contained within a shipment. The usage of HS Codes across Customs Jurisdictions is almost universal. Every item will have an HS Code, and the exact code for a specific item will be based on several factors including material composition, physical state (solid, liquid, and gas), use, and whether it is a finished or unfinished item.
If you are unsure on what HS Codes you should be using for your items, please consult with your courier account manager (e.g. DHL Express account manager).
## Where can I find HS Codes?
It is best to visit your local government website to find the correct HS Codes for your items. Here are some common country links:
* Australia - [Free Trade Agreement Portal](https://ftaportal.dfat.gov.au/)
* New Zealand - [Tariff Finder](https://www.tariff-finder.govt.nz/)
* United Kingdom - [Trade Tariff Lookup](https://www.gov.uk/trade-tariff)
* United States - [Schedule B Search Engine](https://uscensus.prod.3ceonline.com/)
## Import HS Codes from your integrated platform
Starshipit can import HS Codes from some platforms if it is available. Follow the instructions for your platform below to set up HS Codes to import:
#### BigCommerce
Starshipit will automatically import an HS Code for each item if present as a product option. The product option field name must be called **hs code** or **hs codes**. The field names are not case sensitive.
#### CSV Import
Map the Code field to the column you have HS Code present in your CSV files. Use our preformatted CSV template, or change the mapping by following the below:
1. In your Starshipit account, go to **Settings**, then select **CSV File Setup**.
2. Select **Map your own customised CSV**.
3. Enter your mappings as desired.
4. Click **Save**.
See [CSV file integration](/articles/integrations/csv/csv-file-integration) for more information on setting up your CSV import.
#### Magento1 & Magento2
Starshipit will automatically import an HS Code for each item if present as a product attribute. The product attribute code name must be set to **hs_code** for Magento2 and **commodity_code** for Magento1.
#### NetSuite
Starshipit will automatically import an HS Code for each item if present in the **manufacturerTariff** field at the [InventoryItem](https://www.netsuite.com/help/helpcenter/en_US/srbrowser/Browser2016_2/schema/record/inventoryitem.html) level.
#### Peoplevox
Starshipit will automatically import an HS Code for each item if present asana item attribute. To map your Peoplevox item attributes to the HS Code field in Starshipit:
1. In your Starshipit account, go to **Settings**, then select **Integrations**.
2. Click Settings, next to **Peoplevox**.
3. Scroll down until you see **Import HS code from**.
4. Select an item attribute field.
5. Click **Save**towards the bottom of the page.
#### Shopify
1. Set up HS Codes in Shopify using [this guide](https://help.shopify.com/en/manual/shipping/shopify-fulfillment-network/inbound-transfers/preparing-your-products/adding-product-details/adding-tariff-codes "https://help.shopify.com/en/manual/cross-border/duties#add-country-or-region-of-origin-and-hs-codes-to-your-products").
2. Once done, your products will be imported into Starshipit with their HS Code
Note: Due to the way Shopify works the new HS Codes will not import through into Starshipit for orders which existed before their products were updated. Only new orders with those products will display the HS Code in Starshipit.
#### Starshipit API
Include the HS Code in the field **tariff_code** under each item in your items array. e.g.
```
"items":[
{
"description":"Test Item",
"sku":"Test-SKU,
"quantity":"1",
"weight":"1",
"value":"10",
"tariff_code":"123456789"
}
]
```
#### WooCommerce
Starshipit will automatically import the HS Code for each item if present as a product attribute. The product attribute code name must be set to **hs_code**. See [this guide](/articles/integrations/ecommerce-platforms/woocommerce-importing-hs-code-country-of-manufacture) for how to set up the attribute in WooCommerce.
#### Brightpearl
Starshipit will automatically import Country of Manufacture for each item if present as a product attribute. The product attribute code name must be set to PCF_HSCODE
## Set up rules to assign HS Code based on SKU
The advantage of using rules is it saves you time entering an HS Code into your integrated platform for every single SKU. If most of your SKUs have the same HS Code, then only a handful of rules should be required. We recommend using the **Item SKU** condition with the **Starts with the** operator to minimise the number of rules needed.
To set a rule based on the Item SKU prefix:
1. In your Starshipit account, go to **Settings**, then select **Rules**.
2. Click **Add a new rule**.
3. Under Condition(s) select **Item SKU**.
4. Enter the prefix on your SKUs (eg. ABCD)
5. Set the Action as **Set HS Co** and enter a value.
6. Click **Save**.
To set a rule to assign a unique HS Code for each SKU:
1. In your Starshipit account, go to **Settings**, then select **Rules**.
2. Click **Add a new rule**.
3. Under Condition(s) select **Item SKU**, and change the operator from **Starts with** to **Is**.
4. Enter the SKU. For multiple enter, the SKUs each separated by a semi-colon (eg. DEF-01234; GHI-5678; JKL-9101)
5. Set the Action as **Set HS Code** and enter a value.
6. Click **Save**.
7. Repeat steps 2-6 for each HS Code.
## Set up a default HS Code
A default HS Code can be applied to items when this has not been otherwise specified or imported from your integrated platform. The default HS Code will be automatically applied upon clicking print for any items where there is a blank HS Code field.
To set a default HS Code:
1. In your Starshipit account, go to **Settings**, then select **Options**.
2. Scroll down to the **HS Code** field.
3. Enter the HS Code in the field.
4. Scroll to the bottom of the page and click **Save**.
The default HS Code in **Settings > Options** only applies at the time of **printing**. It does not appear in the item details while the order is still in *Unshipped*. The value is applied automatically to items at print time if no HS Code was previously set.
## Manually add an HS Code within an order
1. Open the order you would like to edit from the **New** orders grid.
2. Click **Expand** next to the **Items**section.
3. Select **Edit**, next to the item you would like to edit.
4. In the HS Code field enter the HS Code.
5. Click anywhere to save your changes to the item.
6. When finished click **Save Order** in the bottom left of the order dialogue or continue editing other items.
Learn more about updating orders in [this article](/articles/orders-manifests-reports/faqs/how-to-update-an-order).
---
# Set up MID codes for international shipments
URL: https://support.starshipit.com/articles/13720206390671-set-up-mid-codes-for-international-shipments
Canonical: https://support.starshipit.com/articles/13720206390671-set-up-mid-codes-for-international-shipments
Markdown: https://support.starshipit.com/articles/13720206390671-set-up-mid-codes-for-international-shipments.md
Updated: 2026-08-26
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Step-by-step guide to setting up manufacturer identification (mid) codes for international shipments.
MID (Manufacturer Identification) Codes are used for customs documentation to identify the manufacturer or supplier of goods in international shipments. Starshipit supports importing MID Codes automatically from select platforms, or you can assign them via the Product Catalogue.
Understanding how and where to apply MID Codes ensures accurate Customs documentation, especially when shipping internationally with couriers such as DHL Express.
## MID Code naming in Starshipit
You may see different labels for the same field across Starshipit:
* In order and product screens, this usually appears as **Manufacturer Code** (or **Manufacturer ID** in some UI views).
* In CSV contexts, this may be referenced as **MID Code**.
All of these refer to the same MID value used for customs documentation.
## Why are MID Codes important?
MID Codes are required by Customs for international shipments to identify the manufacturer or supplier of goods. This information is particularly critical for couriers like DHL Express when submitting Electronic Commercial Invoices (eCIs).
A correctly assigned MID Code:
* Helps ensure smooth Customs clearance
* Prevents delays or rejected shipments
* Allows accurate reporting and tracking of supply chain data
:::note
If a MID Code is required and not provided, the shipment may be held by Customs or returned to the sender.
:::
## Where MID Codes are used
MID Codes are sent as part of customs data for supported international shipping workflows.
MID values are currently included on carrier labels or customs documents for:
* DHL Express
* DHL Global
* FedEx
* Asendia
* Parxl
* Seko
## Where can I find or create MID Codes?
MID Codes are not standardised like HS Codes. You’ll typically need to generate them using the following formula:
> Country Code (2 letters) + Manufacturer Name (first 3 characters) + City (first 3 characters) + Street Address (first 4 numbers or characters)
**Example:**
A manufacturer located in Auckland, New Zealand, named “Acme Textiles Ltd” at “12 Queen Street” would have a MID like:
`NZACMAUC12QU`
You can also refer to your DHL Express account manager or customs broker for help generating or validating MID Codes.
## Import MID Codes from your integrated platform
Starshipit supports several methods to source MID values:
* NetSuite custom field sync
* CSV import mapping
* Peoplevox attribute mapping
* Public API (`mid_code`)
* Product Catalogue entry
* Manual entry on individual orders
#### NetSuite
Starshipit imports MID Codes from NetSuite automatically when you have the integration configured.
The MID value is read from the inventory item custom field **`custitem_bfau_mid`** and applied to the matching item in Starshipit. No additional mapping steps are required — as long as that custom field is populated on your NetSuite inventory items, the value will sync across when orders import.
If MID Codes are not appearing on orders imported from NetSuite, verify that the `custitem_bfau_mid` field is populated on the relevant inventory items in NetSuite.
#### CSV Import
You can import MID Codes from your CSV file by mapping the `manufacturer_code` field.
1. In your Starshipit account, go to **Settings**, then select **CSV File Setup**.
2. Select **Map your own customised CSV**.
3. Map your MID Code column to the field `manufacturer_code`.
4. Click **Save**.
Refer to the [CSV integration guide](/articles/integrations/csv/csv-file-integration) for more information.
#### Peoplevox
Starshipit can import MID Codes from Peoplevox using mapped item attributes.
1. Go to **Settings > Integrations**.
2. Click **Settings** next to Peoplevox.
3. Scroll down to **Import Manufacturer Code from**.
4. Select the relevant item attribute that contains your MID Code.
5. Click **Save**.
#### Public API
You can assign MID Codes to shipment items using the Starshipit Public API.
Both the **order creation** and **order update** endpoints support the `mid_code` field inside each item object. The API controller writes this value directly to the shipment item’s Manufacturer Code field.
**Example payload:**
```
{
"order_number": "ORDER12345",
"items": [
{
"sku": "ITEM001",
"description": "Test Item",
"quantity": 1,
"value": 20.0,
"mid_code": "NZACMAUC12QU"
}
]
}
```
Once submitted, the MID Code will appear in the order under the item's **Manufacturer Code** field.
## Assign MID Codes using the Product Catalogue
If you’re not using a CSV import, Peoplevox, or importing via the API the best way to apply MID Codes is through the [Product Catalogue](/articles/integrations/product-catalogue/product-catalogue) in Starshipit.
1. Go to **Settings >** **Product Catalogue**.
2. Click **Edit** on the product you want to update.
3. Enter the MID Code in the **Manufacturer Code** field.
4. Click **Save**.
:::note
Tip If you manage a large catalogue, consider bulk updating via CSV using the Product Import feature.
:::
## Manually add a MID Code within an order
You can also edit an individual order and add a MID Code manually if needed.
1. Open the order from the **New** orders grid.
2. Click **Expand** next to the **Items** section.
3. Select **Edit** next to the item you want to update.
4. Enter the MID Code in the **Manufacturer Code** field.
5. Click anywhere to save the item, then **Save Order**.
## Set MID Codes with rules
Use a rule when the same MID Code should apply to matching orders, such as shipments to a particular destination country.
1. Go to **Settings > Rules**.
2. Click **Add New Rule** and set the conditions that identify the orders.
3. Select **Set Manufacturer Code** as the action.
4. Enter the MID Code to apply, then click **Save**.
5. Import a matching test order or select **Run rules now** for an existing New order.
Check the order item's **Manufacturer Code** before printing. If your integration or Product Catalogue supplies a different MID Code, test the rule with a representative order to confirm the result for your workflow.
## Things to consider
:::warning
**Common mistakes:**
- Leaving the Manufacturer Code field blank for international shipments may result in Customs delays.
- Using an incorrect MID Code format may cause shipment rejections.
- A rule can set a Manufacturer Code for matching orders. Review a test order before relying on a new rule for live international shipments.
:::
---
# Set country of origin for international shipments
URL: https://support.starshipit.com/articles/360002751836-set-country-of-origin-for-international-shipments
Canonical: https://support.starshipit.com/articles/360002751836-set-country-of-origin-for-international-shipments
Markdown: https://support.starshipit.com/articles/360002751836-set-country-of-origin-for-international-shipments.md
Updated: 2026-05-07
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Step-by-step guide to setting up country of origin/manufacture for international shipments.
* Country of Origin (also known as Country of Manufacture) means the country of manufacture, production or growth for an item. This is important for international customs purposes.
* Defining the correct Country of Origin helps to ensure Customs apply the correct duties and taxes.
* Learn about the various methods to add Country of Origin to your items including importing them from your integrated platform, using rules, using a default option, or manual entry.
## Why is Country of Origin important?
The Country of Origin (also known as Country of Manufacture) of each item directly influences what duties and taxes could be applied to items. We say 'could' apply as some country trading partners have free trade or low dutiable thresholds where duties and taxes may apply at different rates.
For example, for shipments between New Zealand and Australia there are various [Free Trade Agreements](https://www.customs.govt.nz/business/tariffs/free-trade-agreements/) in place which provide preferential tariff rates for goods imported into the countries party to that agreement and rules by which goods can qualify for those preferential tariffs (rules of origin).
## Import Country of Origin from your integrated platform
Starshipit can import Country of Origin from some eCommerce, inventory management and other platforms as per the availability. Follow the instructions for your platform below to set up a Country of Manufacture to import:
#### CSV Import
Map the **CountryOfManufacturer** field to the column you have Country of Manufacture present in your CSV files. Use our preformatted CSV template, or change the mapping by following the below:
1. In your Starshipit account, navigate to **Settings** > **CSV File**.
2. Select **Map your own customised CSV**.
3. Enter your mappings as desired.
4. Click **Save**.
See [CSV file integration](/articles/integrations/csv/csv-file-integration) for more information on setting up your CSV import.
#### Magento1
Starshipit will automatically import Country of Manufacture for each item if present as a product attribute. The product attribute code name must be set to **country_of_manufacture**.
#### Magento2
Starshipit will automatically import Country of Manufacture for each item if present as a product attribute. The product attribute code name must be set to **country_of_manufacture** or **country_of_origin**.
#### NetSuite
Starshipit will automatically import Country of Manufacture for each item if present in the **country of manufacture** field at the [InventoryItem](https://www.netsuite.com/help/helpcenter/en_US/srbrowser/Browser2016_2/schema/record/inventoryitem.html) level.
#### Peoplevox
Starshipit will automatically import Country of Manufacture for each item if present as a item attribute. To map your Peoplevox item attributes to the Country of Manufacture field in Starshipit:
1. In your Starshipit account, navigate to **Settings >** **Integrations**.
2. Click Settings, next to **Peoplevox**.
3. Scroll down until you see **Import Country of Manufacture from**.
4. Select an item attribute field.
5. Click **Save**towards the bottom of the page.
#### Shopify
You can set up a Country of Origin in Shopify using [this guide.](https://help.shopify.com/en/manual/cross-border/duties#add-country-or-region-of-origin-and-hs-codes-to-your-products "https://help.shopify.com/en/manual/cross-border/duties#add-country-or-region-of-origin-and-hs-codes-to-your-products")
Note: Due to the way Shopify works, the new Country of Origin will not import through into Starshipit for orders which existed before their products were updated. Only new orders with those products will display the Country of Origin in Starshipit.
#### Starshipit API
Include the Country of Manufacture in the field **country_of_origin** under each item in your items array.
```
"items":[
{
"description":"Test Item",
"sku":"Test-SKU,
"quantity":"1",
"weight":"1",
"value":"10",
"tariff_code":"123456789",
"country_of_origin": "Australia"
}
]
```
#### WooCommerce
Starshipit will automatically import Country of Manufacture for each item if present as a product attribute. The product attribute code name must be set to **country_of_manufacture** or **country_of_origin**. See [this guide](/articles/integrations/ecommerce-platforms/woocommerce-importing-hs-code-country-of-manufacture) for how to set up the attribute in WooCommerce.
#### Brightpearl
Starshipit will automatically import Country of Manufacture for each item if present as a product attribute. The product attribute code name must be set to PCF_COUNTRYO
## Set up rules to assign Country of Origin based on SKU
The advantage of using [rules](/articles/notifications-branded-tracking-rules-child-accounts/business-rules/rules-overview) is it saves you time entering a Country of Origin into your integrated platform for every single SKU. If most of your SKUs have the same Country of Origin, then only a handful of rules should be required. We recommend using the **Item SKU** condition with the **Starts with** operator to minimise the number of rules needed.
To set up a rule based on Item SKU prefix:
1. In your Starshipit account, navigate to **Settings** > **Rules**.
2. Click **Add a new rule**.
3. Under Condition(s) select **Item SKU**.
4. Enter the prefix on your SKUs (eg. ABCD)
5. Set the Action as **Set Country of Manufacture**, and enter a value.
6. Click **Save**.
To set up a rule to assign a unique Country of Origin for each SKU:
1. In your Starshipit account, navigate to **Settings** > **Rules**.
2. Click **Add a new rule**.
3. Under Condition(s) select **Item SKU**, and change the operator from **Starts with** to **Is**.
4. Enter the SKU. For multiple enter the SKUs each separated by a semi-colon (eg. DEF-01234;GHI-5678;JKL-9101)
5. Set the Action as **Set Country of Manufacture**, and enter a value.
6. Click **Save**.
7. Repeat steps 2-6 for each Country of Manufacture.
## Set up a default Country of Origin
A default Country of Origin can be applied to items when this has not been overwise specified or imported from your integrated platform. The default Country of Origin will be automatically applied upon clicking print for any items where there is a blank Country of Origin field.
To set up a default Country of Origin:
1. In your Starshipit account, navigate to **Settings** > **Options**.
2. Scroll down to the **Country of Manufacture** field.
3. Enter the Country of Manufacture in the field.
4. Scroll to the bottom of the page, and click **Save**.
## Manually add Country of Origin within an order
1. Open the order you'd like to edit from the **New** orders grid.
2. Click **Expand** next to the **Items**section.
3. Select **Edit**, next to the item you would like to edit.
4. In the Country of Manufacture field enter the country.
5. Click anywhere to save your changes to the item.
6. When finished click **Save Order** in the bottom left of the order dialogue, or continue editing other items.
Read [this article](/articles/orders-manifests-reports/faqs/how-to-update-an-order) order for more information on updating items.
---
# Add additional shipping documentation to orders (Document Manager)
URL: https://support.starshipit.com/articles/4407149410703-add-additional-shipping-documentation-to-orders-document-manager
Canonical: https://support.starshipit.com/articles/4407149410703-add-additional-shipping-documentation-to-orders-document-manager
Markdown: https://support.starshipit.com/articles/4407149410703-add-additional-shipping-documentation-to-orders-document-manager.md
Updated: 2026-05-07
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Learn how to add additional shipping documentation to orders (document manager).
* Some shipments require additional documentation to be included for customs clearance or courier compliance. This applies primarily to international shipments but may also be needed for certain domestic deliveries.
* Courier-related documents, such as customs invoices, prescriptions, or declarations of origin, are transmitted electronically to supported couriers. Starshipit supports this functionality for DHL Express and FedEx through Paperless Trade or Electronic Data Transmission.
* In addition to courier documentation, it is also possible to attach general order documents that are stored for reference within the order but not sent to the courier. For example, teams may add quality control forms or photos of packed goods to support internal workflows.
* Supported file types are PDF and JPEG.
## Attach courier-related documents
Courier-related documents are required when a shipment must include files such as:
* MSDS (Material Safety Data Sheet)
* Prescriptions or medical certificates
* Fabric certificates
* Licenses or permits
* Declarations of origin
These documents can be attached manually within the order details page or automatically using rules.
### To attach a courier-related document manually
1. Open the order from the Orders grid.
2. In the Order Documents section, select Add Document.
3. Upload the relevant file (for example, a customs invoice or license). **Note: Order Document will not be sent to the couriers.**
4. The document appears in the list of attached files. Documents added by rules also appear here and can be viewed, removed, or replaced if required.
5. When the order is printed, all attached courier-related documents are transmitted electronically to DHL Express or FedEx if Paperless Trade or Electronic Data Transmission is enabled.
### Set the default document type
You can choose the document type selected by default when your team uploads a document from an order.
1. Go to **Settings > Options**.
2. Select the preferred **Default order-document upload type**.
3. Click **Save**.
The uploader still lets the user choose a different type for an individual file. If no default is configured, Starshipit uses **Order Document**.
## Attach general order documents
General order documents are used for internal reference and record keeping. These documents remain stored with the order and are not transmitted to couriers. Examples include packing photos, checklists, or quality control forms.
General order documents can be added manually or automatically using rules.
### To attach a general order document manually
1. Open the order from the **Orders** grid.
2. In the **Order Documents** section, select **Add Document**.
3. Upload the desired file.
4. The file remains available within the order for future reference.
## Automatically attach documents using rules
Use the Document Manager and rule engine to attach either courier-related or general order documents automatically when orders import.
### Step 1: Upload documents to your account
* Go to Settings > Document Manager.
* Open the Uploads tab.
* Select the files to upload.
* Choose a Document Type:
* Customs Invoice (replaces the default commercial invoice)
* Proof of Purchase
* License or Permit
* General Document (for internal use only)
* Click Upload.
Uploaded files appear under the File List tab.
### Step 2: Assign documents using rules
1. Go to Settings > Document Manager > Rules.
2. Select Add a new rule.
3. Set the conditions for when the document should be applied.
4. Choose the Assign Document action.
5. Enter the filename or use variables such as %OurRef% or %TheirRef% to match the order number or reference.
6. Rules apply automatically when orders import. To reapply after making changes, select Run Rules from the Document Manager.
### Step 3: Print orders
* When an order is printed, all attached documents are included automatically. Courier-related files are transmitted electronically to DHL Express or FedEx, while general order documents remain stored in the order only.
## Manage and review order documents
* All attached documents, whether added manually or via rules, appear in the **Order Documents** section.
* Files can be downloaded, removed, or replaced before printing.
* Orders may include multiple attachments if more than one file meets a rule condition or is added manually.
* Only orders created within the last 90 days are eligible for document attachments.
## FAQ
How do I know if a file has been attached to an order?
Attached documents appear in the Order Documents section of the order details view.
How do I un-assign a file from my orders?
Files can be unassigned either from the File List in Document Manager or directly within the order details. You can not remove files from an order once the order has been shipped for auditing purposes.
**From the File List:**
* To remove a single file from all assigned orders, select Unlink in the file’s row.
* To remove all files assigned by a specific rule, select Remove assigned rule.
**From the order details:**
* Open the order and go to the Order Documents section.
Can the same file be attached to multiple orders?
Yes, you can attach the same file to multiple orders.
Can one order have multiple files attached?
An order can have multiple files attached if multiple files meet the rule conditions.
How do I delete a file from my file list?
In the File List, you can remove a file from your file list by clicking on the **Remove** option in the file's row.
Is it possible to upload multiple files with the same name?
Document manager does not currently support multiple files with the same name (regardless of whether the file extension is different). When you upload a file with the same name, the new file will override the older file.
What orders are eligible for documents to be added to them?
All orders less than 90 days old can have documents attached to them. They will just need to meet the conditions that are set in your rule settings.
Can I download the commercial invoice from a printed order with associated documents?
This depends on the type of document you attached to the order.
* Customs Invoice: You won't be able to download the commercial invoice via the Re-print drop-down > Download commercial invoice or when selecting the Order > Actions drop-down > Download the commercial invoice. This is because we do not store your copy of the commercial invoice on our side
* Proof of Purchase & Permit: Commercial invoice will be able to be downloaded from the account (as long as there wasn't a customs invoice also attached)
---
# Configure commercial invoice values and discounts
URL: https://support.starshipit.com/articles/360001991096-configure-commercial-invoice-values-and-discounts
Canonical: https://support.starshipit.com/articles/360001991096-configure-commercial-invoice-values-and-discounts
Markdown: https://support.starshipit.com/articles/360001991096-configure-commercial-invoice-values-and-discounts.md
Updated: 2026-05-07
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Learn commercial invoice: order values, tax, product values, discounts and how to adjust them.
* Starshipit has three order value adjustment options to help you manage customs values on commercial invoices.
* It is recommended that you declare the total value of the items and that the total of the line items add up to this declared value.
## How it works
The value declared on commercial invoices is a grey area. Should it be the actual value of the items? The value paid? Should it include tax? Shipping? What if it is free shipping?
Customs are likely to flag any commercial invoices which do not add up, i.e. where the line items do not match the total amount declared so, we recommend you ensure everything sums to avoid shipments getting flagged by customs for being declared incorrectly.
Starshipit supports several order value adjustment functions to change declared values based on line item totals, tax, shipping and discounts.
From your eCommerce or inventory platform we will try and import the below fields (if available) to be used in order value adjustment:
* Total Value paid by the customer
* Subtotal
* Tax
* Discount
## 1. Set your order value adjustment setting
1. In [Starshipit](https://app2.starshipit.com/), go to **Settings >** **Integrations**.
2. Scroll down until you see the **Order Value Adjustments** section.
3. Select one of the four radio buttons (more info on options available are below).
4. Click **Save**.
**No Adjustments**With no order adjustment, Starshipit will use either the total value or sub-total depending on the platform.
**Adjustment based on Total Value**Starshipit will always take the total amount paid by your customer and use this as the **master** **value**. Working backwards Starshipit then adjusts the item values (on import) to ensure that all items add up to this master value.
**Adjustment based on Total Value - Tax**This works the same way as **Adjustment based on Total Value**, except tax is subtracted from the total amount paid, before adjusting the line items.
**Adjustment based on Total Value - Tax - Shipping**This works the same way as **Adjustment based on Total Value**, except tax, and shipping are subtracted from the total amount paid, before adjusting the line items.
:::note
There is also an option to apply the actual cost of shipping if you are using DHL Express(seethis articleto set this up), if you have this option enabled, then ensure you select Adjustment based on Total Value - Tax - Shipping.
:::
## 2. Example of how this works
We will go through a working example of **Adjustment based on Total Value - Tax - Shipping**.
We will import the Total Paid by the customer, the tax amount and the shipping amount from your eCommerce platform. In this example let's say we have the following order:
**Shopify order #1001**
**Total paid**This is the amount that the customer paid at checkout. In this example, let's say this is $500.
**Shipping paid**What the customer paid on checkout for shipping. Let's say this is $20.
**Taxes**The total amount of tax that was paid. Let's say $50.
**The order value adjustment is calculated as follows:**Total Paid ($500) - Shipping ($20) - Taxes ($50) = $430. The declared value we send to the courier will be $430. This is a 14% decrease.
Then for international shipments, the item values must match the total value. So to ensure that the tax is removed from the item values we will decrease all items in the order by 14%.
So if our above order contained:
1 X $300 necklace * 0.86 = $**258**
1 X $200 earrings * 0.86 = $**172**
---
# Set up shipper tax numbers
URL: https://support.starshipit.com/articles/360002115215-set-up-shipper-tax-numbers
Canonical: https://support.starshipit.com/articles/360002115215-set-up-shipper-tax-numbers
Markdown: https://support.starshipit.com/articles/360002115215-set-up-shipper-tax-numbers.md
Updated: 2026-05-07
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Step-by-step guide to setting up shipper tax numbers.
In Starshipit you can set up Shipper Tax Numbers when shipping to international destinations. These tax numbers will be added to the orders at the time of printing/dispatch. This includes IOSS numbers, EORI numbers and VAT/GST numbers.
IOSS is currently supported in Starshipit for the following couriers:
* Australia Post eParcel
* Australia Post MyPost Business
* DHL Express
* DHL eCommerce Asia Pacific
* Deutsche Post
* DPD UK
* DPD Local UK
* NZ Post International
* UPS
* Hermes
* Seko
* Royal Mail
VOEC is supported for shipments where the courier accepts it, including Deutsche Post and DHL Express GMB.
## How it works
Some countries require a tax number to be supplied so taxes are correctly charged to your business. Starshipit supports specifying different tax numbers for each country.
For example, you could set up the following:
* When sending to Australia use your **ABN**.
* When sending to New Zealand use your **GST** number.
* When sending to the UK use your **VAT** number.
* When sending to the EU use your **IOSS** number.
* When sending to Norway use your **VOEC** number.
Starshipit matches tax numbers to the shipment destination, so each order uses the right registration number for that country.
In some cases, it may also be necessary to configure a Sold To (Billing) address with its own tax numbers.
For this type of setup please refer to our article on setting up [Sold To (Billing) addresses for DHL Express.](/articles/international-shipping-compliance/customs-duties/set-up-additional-parties-addresses)
## Set up your shipper tax numbers
1. In your Starshipit account, go to **Settings** > **Options**.
2. Scroll down to the **Shipper Tax Settings** section.
3. Click **Add New** > select the Tax Type, enter your Tax Number, select an Applicable Destination > click **Add.**
Repeat step 3 for each tax number that is required.
## Using multiple IOSS numbers in Starshipit
Starshipit supports using multiple IOSS numbers if you receive orders from more than one marketplace.
You can do this by using the [Starshipit's Rules](/articles/notifications-branded-tracking-rules-child-accounts/business-rules/rules-overview "/articles/notifications-branded-tracking-rules-child-accounts/business-rules/rules-overview") to assign each of your IOSS numbers to their respective orders.
To set up a rule which assigns an IOSS to an order, go to:
1. **Settings** > **Rules** > click **Add a new rule**.
2. Select the required **Condition(s)**.
3. Set the **Action** to **Set Shipper Tax Number**.
4. Set the **Value** to **IOSS - Import One-Stop-Shop**.
5. Enter the **IOSS number** you would like applied to the order > click **Save**.
This rule will be run automatically when each order is imported.
To apply this rule to orders which are already in your account go to **Settings** > **Rules** > in the Apply rules to new/unshipped orders section and click **Run rules now.**
---
# Receiver tax numbers
URL: https://support.starshipit.com/articles/9133191385-receiver-tax-numbers
Canonical: https://support.starshipit.com/articles/9133191385-receiver-tax-numbers
Markdown: https://support.starshipit.com/articles/9133191385-receiver-tax-numbers.md
Updated: 2026-05-20
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Step-by-step guide to adding receiver (destination) tax numbers to orders for customs and compliance.
Receiver tax numbers are identifiers you may need to provide for the receiver when shipping internationally (for example, a destination EORI number, UKIMS number, or a national ID). Some couriers use these details for customs declarations and clearance.
Receiver tax numbers are different from shipper tax numbers:
* **Shipper tax numbers** are set in **Settings > Options** and applied automatically based on destination country. See [Set up shipper tax numbers](/articles/orders-manifests-reports/orders/set-up-shipper-tax-numbers).
* **Receiver tax numbers** are usually provided by the receiver and are added per order in Starshipit.
## Before you start
* Confirm which tax identifier is required for your shipment and destination (and whether it’s mandatory for your courier service).
* Make sure your courier and service support sending receiver tax numbers.
## Supported couriers and services
Starshipit can send receiver tax numbers for selected couriers and services, including:
* **DHL Express**: receiver registration/tax numbers such as EORI, VAT, national ID, passport number, and other supported DHL tax types.
* **DPD UK**: receiver EORI, VAT, PID/National ID, and UKIMS where applicable.
* **Royal Mail**: receiver EORI and VAT.
* **UPS**: receiver tax identification number.
* **NZ Post / eShip**: receiver VAT/GST/ABN-style tax number where supported by the service.
Depending on the courier, receiver tax numbers may only be sent for international services, customs-enabled services, or specific destination countries. If a required tax type is not available for your courier or service, contact [Starshipit Support](https://help.starshipit.com) before dispatching.
## Add receiver tax numbers to an order
1. In [Starshipit](https://app2.starshipit.com/), go to **Orders**.
2. Open the order you want to ship.
3. In the order sidebar, find **Tax Details**.
4. Select the relevant tax number type and enter the receiver’s identifier.
5. Print/dispatch the shipment as normal.
:::note
Available tax number types (and whether they are required) depends on the courier, destination, and service. For courier-specific examples, see:
* [How to set up Royal Mail](/articles/couriers/royal-mail/how-to-set-up-royal-mail) (UKIMS and customs)
* [Set up DPD UK](/articles/couriers/dpd/set-up-dpd-uk) (Submitting PID Number)
:::
---
# Set up Additional Parties addresses
URL: https://support.starshipit.com/articles/360002115335-set-up-additional-parties-addresses
Canonical: https://support.starshipit.com/articles/360002115335-set-up-additional-parties-addresses
Markdown: https://support.starshipit.com/articles/360002115335-set-up-additional-parties-addresses.md
Updated: 2026-05-07
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Step-by-step guide to setting up additional parties addresses.
* Use Additional Parties in Starshipit to include different company or contact details for international shipments. This lets you specify who acts as the Buyer, Seller, Exporter, Importer, or Broker for each destination.
* Starshipit automatically uses your pickup address as the Sender. When generating customs documents or commercial invoices, it substitutes the relevant Additional Party address based on the shipment’s destination country.
* You can configure country-specific addresses, assign roles, and add tax numbers (such as VAT, EORI, or GST) so that your carrier receives the right details for customs and billing.
## Supported carriers
| Carrier | Supported roles | Used for |
| --- | --- | --- |
| **DHL Express** | Buyer, Seller, Importer, Exporter, Broker | Commercial invoices and export declarations |
| **FedEx** | Buyer (Sold-To), Importer | Commercial invoices and third-party billing |
| **Australia Post Global Logistics** | Buyer | Commercial clearance data |
## What it looks like
## 1. Set up your Additional Parties addresses
1. In Starshipit, go to **Settings > Options**.
2. Scroll to the **Additional Parties Customs** section.
3. Click **Add new**.
4. Select an **Additional Party Type** (Buyer, Seller, Importer, Exporter, or Broker).
5. Enter the company name, contact name, email, and phone number.
6. Choose the **destination countries** this address applies to.
7. Click **Save**.
8. Repeat for any other Additional Parties you need.
:::note
**Countries to apply** refers to the **destination** countries for shipments.
:::
## 2. Set up tax numbers for Additional Parties
You can add one or more tax identifiers for each Additional Party — such as VAT, EORI, or GST.
1. In Starshipit, go to **Settings > Options**.
2. Scroll to **Additional Parties Customs**.
3. Click **Add new**, or **Edit** an existing Additional Party.
4. Scroll to the **Tax Settings** section.
5. Click **Add new**.
6. Enter the tax type, tax number, and select the applicable destination.
7. Click **Add**.
8. Repeat for all required tax numbers.
## 3. Which roles to use
| Role | Description | Common use |
| --- | --- | --- |
| **Buyer** | The person or company purchasing the goods. | Often used for the consignee or destination customer (required by DHL, FedEx, and AusPost GL). |
| **Seller** | The person or company selling the goods. | Usually your business or a third-party supplier. |
| **Exporter** | The party responsible for exporting the goods from the origin country. | Required for DHL commercial invoices when exporting goods. |
| **Importer** | The party responsible for importing the goods into the destination country. | Used by DHL and FedEx to identify the importer of record. |
| **Broker** | A customs broker handling clearance. | Used only by DHL Express if a broker manages customs on behalf of the receiver. |
---
# Choose DDP or DDU for international shipments
URL: https://support.starshipit.com/articles/4415554835215-choose-ddp-or-ddu-for-international-shipments
Canonical: https://support.starshipit.com/articles/4415554835215-choose-ddp-or-ddu-for-international-shipments
Markdown: https://support.starshipit.com/articles/4415554835215-choose-ddp-or-ddu-for-international-shipments.md
Updated: 2026-05-06
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Learn how to configure DDP (Delivered Duty Paid) and DDU (Delivered Duty Unpaid) Incoterms for international shipments in Starshipit.
:::warning
**U.S. regulation change (29 Aug 2025):** The United States ended the de minimis exemption which allowed shipments under $US800 to enter the US duty-free. Make sure to use DDP to keep deliveries moving. Stay up-to-date in our [guide here](/articles/international-shipping-compliance/customs-duties/shipping-to-the-us-live-de-minimis-updates-disruption-notices-and-guidance).
:::
Starshipit supports specifying the Incoterm of a shipment for DHL Express, DHL eCommerce, UPS, DPD, Royal Mail, FedEx, Seko, Parxl and Australia Post eParcel (APGL services only).
* Incoterms is an acronym that stands for International Commercial Terms and relates to how you manage the duties and taxes required when shipping internationally.
* The most common Incoterms in freight delivery are DDP (Delivery Duty Paid) and DDU (Delivery Duty Unpaid):
+ DDP (often referred to as Sender Pays Duty) should be used when you would like to pay the import charges, taxes etc on behalf of the customer. This is the Incoterm used when your customer prepays their duty charges at checkout to you, the seller so that when the package goes through customs they aren't charged again
+ DDU means the obligation to pay customs charges are on the buyer, rather than the seller.
* Starshipit has many different ways for you to specify which Incoterm you would like to use, detailed below.
* **Couriers without a DDP toggle in the UI**: Some couriers don’t have a direct DDP option in the order UI but can still support DDP when using the **Import Rule → Set Sender Pays Duties** action. This sets the DDP flag on the carrier’s API for the shipment.
+ Australia Post eParcel
+ DHL eCommerce
## Set your default option within the courier settings
1. Go to **Settings >** **Couriers** > Select your courier settings > **Advanced**.
2. Tick or untick the **Duties and Taxes Paid/Sender Pays Duty** option depending on what you would like your default to be.
## Use rules to automatically assign Incoterms
You may wish to apply Incoterms based on certain criteria. For example, all orders under $100 should be DDU or all orders to the EU should be DDP. You can configure this using Starshipit's [rules engine](/articles/notifications-branded-tracking-rules-child-accounts/business-rules/rules-overview).
1. Go to **Settings >** **Rules** > **Create a new rule**.
2. Select the relevant condition for when you would like the rule to apply.
3. Set the action to **Set Sender Pays Duty** = True (DDP) or **Set Sender Pays Duty** = False (DDU).
## On an order-by-order basis
You may wish to only specify specific orders to have a different Incoterm than the rest of your shipments. For example, if you were sending out an exchange and the customer already paid taxes you may want to set the new order to DDP so that you pay for the customs charges.
1. Open the order from the new orders grid.
2. Tick the **Duties & Taxes Paid** box.
3. Print the order as per usual.
General Notes
'Set Sender Pays Duties' rule = flag DDP
'Set Incoterm' rule = flag type of DDP (optional)
**DDP in New Orders**
For supported Australia Post APGL and DHL eCommerce services, you can select the DDP option directly in New Orders before creating the shipment. Choose an eligible service and tick the DDP option before printing.
**Couriers without a DDP toggle in the UI**
Some couriers don't have a direct DDP option in the order UI but can still support DDP when using the Import Rule → Set Sender Pays Duties action. This sets the DDP flag on the carrier's API for the shipment.
Australia Post eParcel (non-APGL services)
---
# Starshipit Landed Costs
URL: https://support.starshipit.com/articles/13975380558863-starshipit-landed-costs
Canonical: https://support.starshipit.com/articles/13975380558863-starshipit-landed-costs
Markdown: https://support.starshipit.com/articles/13975380558863-starshipit-landed-costs.md
Updated: 2026-07-01
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Offer transparent international pricing by calculating, charging, and remitting duties and taxes upfront.
Offer transparent pricing for international orders by calculating, charging, and remitting duties and taxes upfront.
When selling internationally, a common challenge is unexpected import costs. **Starshipit Landed Cost Guarantee (LCG)** removes guesswork by calculating, collecting, and remitting landed cost charges on your behalf so customers see the full cost at checkout and are not charged again on delivery.
:::note
Starshipit Landed Costs currently supports Shopify as the ecommerce platform integration.
:::
## What is a landed cost?
The landed cost is the total cost of getting an order from your store to the customer’s door. It includes:
* Product cost
* Shipping and insurance
* Customs duties
* Import taxes (e.g. VAT, GST)
* Handling and remittance fees
## What is Starshipit LCG?
Landed Cost Guarantee (LCG) ensures duties and taxes are calculated accurately and prepaid. You choose which destination countries use LCG; orders to those countries are automatically sent **DDP (Delivered Duty Paid)**. Other international orders can continue using standard non-DDP workflows.
:::note
Supported couriers: Australia Post, NZ Post, UPS, FedEx, DHL Express.
:::
## Pricing
| Fee type | Details |
| -------- | ------- |
| Annual fee | $1,000 USD per year |
| Starshipit LCG fee | 10% of the calculated landed costs per order |
| Billing cadence | Landed cost charges are invoiced through Starshipit. The Starshipit fees are included in the landed costs shown at checkout, so your customers cover these costs rather than paying them separately later. |
## How it works
Starshipit Landed Costs (LCG) automatically calculates and manages duty, tax, and fee components from checkout through to customs payment and reconciliation. Here’s an overview of how it works:
1. **Choose destination countries.** Select the markets where you want landed costs enabled. You can choose individual countries or all countries.
2. **Prepare product data.** Each product needs an HS code and country of origin so duties and taxes can be calculated accurately.
3. **Set up checkout rates.** Starshipit uses checkout rates to show duty and tax-inclusive shipping options to buyers.
4. **Submit an access request.** The Starshipit team reviews and enables landed costs on your account.
5. **Create DDP shipments.** For approved landed cost shipments, Starshipit sends the shipment as **DDP (Delivered Duty Paid)** so duties and taxes are paid by the sender rather than collected from the receiver.
6. **Review invoices and activity.** Use the in-app Landed costs area to review rate requests, invoice totals, and invoice PDFs.
## Set up landed costs (LCG)
:::warning
Before you start, each product must have a valid HS code and country of origin to ensure accurate duty calculations.
:::
1. Open [Landed costs in Starshipit UI 2.0](https://next.starshipit.com/settings/landed-costs?section=onboarding).
2. Open the **Setup** tab.
3. Read the introduction and pricing information, then click **Get started**.
4. Select the destination countries where you want landed costs enabled. Choose **All countries** if landed costs should apply everywhere.
5. Review the Zonos terms of service PDF, then tick **I have read and accept the landed-cost terms**.
6. Review the product readiness step. Starshipit checks your products for missing HS codes and missing country of origin values. You can continue even if some products still need attention, but those products should be fixed before you rely on landed cost calculations.
7. Review your checkout rates setup. Landed costs uses checkout rates to show duty and tax-inclusive options to buyers.
8. Submit your landed cost access request. The Starshipit team will review the request and enable landed costs on your account.
After you submit the request, the Landed costs page shows the status of your access request. You can return to [Landed costs in Starshipit UI 2.0](https://next.starshipit.com/settings/landed-costs?section=onboarding) to continue preparing products, reviewing rate requests, or checking invoices.
## Manage your products
Use the **Products** tab in [Landed costs in Starshipit UI 2.0](https://next.starshipit.com/settings/landed-costs?section=products) to review the product data used for tariff calculation and customs declarations.
:::warning
Required for accurate duties. Each SKU must have a valid HS code and country of origin. We'll flag anything that's missing and help you fill it in.
:::
### Review and update products
The Products tab shows your product catalogue with the product name, SKU, HS code, country of origin, status, and price.
You can:
* Search by product name, SKU, or barcode.
* Filter to all products, products that need attention, products missing an HS code, or products missing an origin.
* Edit the HS code and country of origin directly from the product table.
* Create a product manually.
* Import product data from a CSV.
* Download a CSV template.
* Export your products to CSV.
* Sync product data from Shopify.
* Select products and update their country of origin in bulk.
* Select products and click **Push to Starshipit** when you need to sync landed cost product data back to Starshipit.
### Get HS code suggestions
If a product is missing an HS code, use the product action menu to get HS code suggestions. Review the suggested code and description, then apply the code if it matches the product.
:::warning
HS code suggestions are a guide only. You are responsible for confirming the correct HS code for your products.
:::
## Set up checkout rates
To display landed costs at checkout, ensure you have Starshipit checkout rates enabled for each LCG country in your ecommerce platform, such as Shopify.
* Learn more [about checkout rates](/articles/rates-at-checkout/set-up-guides/about-live-rates-at-checkout-supported-couriers) and [how to set them up.](/articles/rates-at-checkout/set-up-guides/set-up-rates-at-checkout)
### Review rate requests
After approval, you can monitor shipping rate lookups from your store in the **Rate requests** tab. This shows how landed cost rates are being calculated and displayed to customers.
The summary shows:
* **Requests:** Total landed cost rate requests.
* **Errors:** Requests that returned an error.
* **Landed cost applied:** Requests where landed costs were included.
* **Avg response:** Average response time.
Use the search field to find requests by country, postcode, currency, or request ID. Open a request to review the destination, response timing, available shipping methods, total amount, tax amount, duty amount, and any errors.
## Review invoices
Use the **Invoices** tab to review your landed cost invoices. The invoice list shows the invoice number, created date, shipment count, total, status, and paid date.
Open an invoice to:
* Review invoice totals and shipment counts.
* Check whether the invoice is paid or pending.
* Send the invoice email again.
* Download the invoice PDF.
## Enable or disable landed costs
Use the **Settings** tab to check your landed cost status and turn landed costs on or off.
The status area shows:
* Whether the landed cost add-on is active.
* Whether landed costs are enabled for the account.
* Whether your application is pending or approved.
* When the application was submitted.
:::note
If your account has not been approved yet, or the landed cost add-on is not active, you may need to contact the Starshipit team before you can enable landed costs.
:::
## FAQ
Which couriers support LCG?
Australia Post, NZ Post, UPS, FedEx, DHL Express.
Can I keep using non-DDP couriers?
Yes. Enable LCG by destination country; other international orders can use your usual non-DDP setup.
How are fees calculated?
$1,000 USD per year, plus 10% of the calculated landed costs per order.
Can I disable LCG?
Yes. Open [Landed costs in Starshipit UI 2.0](https://next.starshipit.com/settings/landed-costs?section=settings), then use the **Enable landed costs** toggle.
Do I need HS codes and country of origin?
Yes. Both are required for accurate duty calculations. You can review and update products from the **Products** tab in [Landed costs in Starshipit UI 2.0](https://next.starshipit.com/settings/landed-costs?section=products).
What if customs reassesses a shipment?
Amounts are guaranteed by Starshipit. You won't pay more than the quoted total; Starshipit covers any variance.
Is there a sandbox?
No. LCG operates in live mode once approved.
Does it work at checkout?
Yes. LCG works with Starshipit's existing checkout rates. Ensure checkout rates are configured for all countries you enable.
Where do I access Landed Costs?
Open [Landed costs in Starshipit UI 2.0](https://next.starshipit.com/settings/landed-costs?section=onboarding). The old landed costs portal is no longer used, and customers using Classic UI may not see Landed costs in their settings menu.
## Troubleshooting
**Missing or duplicate products after sync**
Search for the product in the **Products** tab in [Landed costs in Starshipit UI 2.0](https://next.starshipit.com/settings/landed-costs?section=products). If the product is still missing, check that it exists in your Starshipit product catalogue and has a valid SKU.
**No HS code suggestions appear**
Try refining the product title or description so the product can be classified more accurately, then request HS code suggestions again.
**Data didn’t update after syncing**
Refresh the Products tab. If you imported a CSV or synced from Shopify, check that the product SKU matches the product you intended to update.
**Not seeing rate data in Rates Requests**
Make sure checkout rates are configured and that your store has processed rate lookups since LCG was approved. Without activity, no data will appear.
**Checkout preview shows no rates**
LCG approval is required before landed costs appear in checkout rates. If rates are still blank after approval, check that checkout rates are active for all LCG countries and that the products have HS codes and countries of origin.
**Approval taking longer than expected**
Account approvals depend on courier verification. If it’s been more than two business days, contact [our support team](https://help.starshipit.com) for assistance.
**Can’t access Landed Costs**
Open [Landed costs in Starshipit UI 2.0](https://next.starshipit.com/settings/landed-costs?section=onboarding). If you cannot access the page or cannot enable landed costs, contact [our support team](https://help.starshipit.com) for assistance.
---
# Using Zonos with Starshipit
URL: https://support.starshipit.com/articles/13985208875791-using-zonos-with-starshipit
Canonical: https://support.starshipit.com/articles/13985208875791-using-zonos-with-starshipit
Markdown: https://support.starshipit.com/articles/13985208875791-using-zonos-with-starshipit.md
Updated: 2026-05-07
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Learn how to integrate Zonos with Starshipit to display landed costs at checkout and handle duties and tax remittance.
Zonos provides a checkout app that displays landed costs (including duties and taxes) to your international customers before purchase. When integrated with Starshipit, Zonos can also handle payment of these duties and taxes on your behalf.
:::warning
This setup applies only to merchants with a paid Zonos subscription where Zonos collects and remits duties and taxes on your behalf. It does not apply if you are using the free Zonos + Australia Post or New Zealand Post accounts, or using Starshipit's Landed Cost Guarantee, where Starshipit collects and remits duties and taxes directly.
:::
## Before you begin
You must have:
* An active **Zonos subscription** that includes duties and tax collection and remittance.
* Your **Zonos DDP account number** for billing (provided by Zonos Support).
* The **Zonos Shopify module** installed and configured.
* Your **Tax IDs** (e.g., IOSS, VAT, EORI, GST) entered in both **Zonos** and **Starshipit**.
## How it works
1. **At checkout:** The *Zonos Shopify module* calculates and displays the total landed cost (product, shipping, duties, and taxes) to your customers. Customers prepay these charges as part of their purchase.
2. **Order flow:** After checkout, both **Zonos** and **Starshipit** pull the same order data directly from Shopify.
* **Zonos** uses this order information to manage duties and tax collection and remittance.
* **Starshipit** imports the same order for fulfillment and label creation.
There is no direct data connection between Zonos and Starshipit.
3. **Within Starshipit:** When your orders import from Shopify into Starshipit, you need to ensure:
* Each order is marked as **DDP (Delivered Duty Paid)** — meaning duties and taxes are prepaid.
* Your **carrier integrations** (e.g., DHL, FedEx, UPS) are configured so the payer of duties is your **Zonos DDP account number**.
* Your **Tax IDs** (e.g., IOSS, VAT, EORI, GST) are entered in Starshipit so they are sent with your customs data.
This ensures duties and taxes are billed to Zonos instead of your courier account, and your customs documentation includes the correct tax information.
4. **Courier transmission:** When you print a label, Starshipit sends both the **DDP Incoterm** and your **Zonos payer account** to the courier via their API. Zonos is billed for duties and taxes when the shipment clears customs, and your customer will not be charged again at delivery.
## Step 1: Add your tax IDs
Proper tax ID setup ensures duties and taxes are calculated and remitted correctly.
* In Zonos: Follow Zonos’ official documentation on [adding tax IDs](https://zonos.com/docs/global-ecommerce/settings/tax-ids)
* In Starshipit: Add the same tax IDs in [Starshipit](/articles/orders-manifests-reports/orders/set-up-shipper-tax-numbers) so they’re included on customs documents and courier data submissions.
:::note
Ensure your Tax IDs match between Zonos and Starshipit for each region you ship to, as some couriers validate tax identifiers electronically.
:::
## Step 2: Configure DDP using a rule
You can automatically apply DDP to all relevant shipments by creating a rule in Starshipit that sets “Sender Pays Duty (DDP)” based on your chosen conditions.
### To create a DDP rule
1. Go to **Settings > Rules > Add new rule**.
2. Under **Condition**, choose when the rule should apply — e.g., *If Destination Country = United States*.
3. Under **Action**, select **Set Sender Pays Duty = True (DDP)**.
4. Click **Save Rule**.
For more detail, see how you can [configure your shipment’s DDP/DDU settings in Starshipit](/articles/international-shipping-compliance/customs-duties/configuring-your-shipment-s-ddp-ddu).
:::note
You can only configure duties to be paid by one payer — either Zonos or you (the sender). You cannot have some DDP shipments paid by Zonos and others by yourself within the same courier setup.
If you only use Zonos for a subset of orders, create a child account (for example, "Zonos Orders") and a rule to route those orders — e.g., *If Country = United States → Allocate order to Zonos child account*. Configure couriers in that child account with your Zonos DDP billing details.
:::
## Step 3: Configure each courier
### DHL Express
1. Go to **Settings > Couriers > DHL Express > Advanced**.
2. Scroll to the Customs Invoice Section
3. Enter your **Zonos account number** in the **DHL Duty and Tax number field**
4. Click **Save**.
### FedEx
1. Go to **Settings > Couriers > FedEx** .
2. Under Duty and Tax Payment Type, select **Third Party** from the drop down
3. Enter your **Zonos account number** in the **Duty and Tax number field**
4. Click **Save**.
## What happens when you print
* The shipment is created with the **DDP (Delivered Duty Paid)** Incoterm.
* Starshipit sends your **Zonos DDP account number** and **Tax IDs** to the courier’s API.
* Zonos is billed for duties and taxes when the shipment clears customs.
Your customer will not be charged again at delivery.
## Table Rates and Zonos
Zonos can match an eligible Starshipit Table Rate when the order is printed. Keep the Table Rate service name and code consistent with the Zonos service you configured, then test the complete checkout and label workflow before making the rate available to customers. If Starshipit cannot match the selected Table Rate to a Zonos service, it cannot create the Zonos shipment for that order.
## Retain item prices from imported orders
If your Starshipit account has the **Retain item prices** option for Zonos, enable it when you want Starshipit to keep the item values imported from your sales channel instead of replacing them with landed-cost-adjusted values.
Use this when your commercial invoice or customs data must show the original item prices from the order. This is commonly useful when Zonos is calculating duties and taxes separately, but you still want item-level values in Starshipit to match the source order.
After enabling the setting, import a test order and check the item values in Starshipit before printing a live label.
---
# Ship to the US with Zonos and Australia Post
URL: https://support.starshipit.com/articles/13670236989455-ship-to-the-us-with-zonos-and-australia-post
Canonical: https://support.starshipit.com/articles/13670236989455-ship-to-the-us-with-zonos-and-australia-post
Markdown: https://support.starshipit.com/articles/13670236989455-ship-to-the-us-with-zonos-and-australia-post.md
Updated: 2026-05-06
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Ship to the US with Australia Post and Zonos, including upfront duties and taxes.
With recent changes to US customs rules, all shipments, regardless of value, now require duties and taxes to be paid upfront. To make this easy, Australia Post has partnered with Zonos so you can continue shipping without disruptions or unexpected costs for your customers.
### The changes
The US has removed the *de minimis* threshold for imports. Previously, goods valued under USD 800 could enter the country without duties and taxes. With this change, **all shipments require duties and taxes to be calculated and collected at the time of import**.
For merchants, this means you must ship on a **Delivered Duty Paid (DDP)** basis.
Learn more about these changes in our guide [here](/articles/international-shipping-compliance/customs-duties/shipping-to-the-us-live-de-minimis-updates-disruption-notices-and-guidance).
---
### What Zonos does
[Zonos](https://zonos.com/) is a third-party platform that simplifies cross-border trade. To support Australian businesses through this change, **Australia Post has partnered with Zonos**, a global leader in cross-border compliance and landed cost solutions. This partnership gives Australia Post merchants a clear, supported pathway to continue shipping to the US without disruption.
By integrating your Australia Post account with Zonos, you’ll be able to:
* Automatically calculate and pay duties and taxes on US shipments.
* Bill those duties and taxes back to your Zonos payment method (so the customer doesn’t need to pay on delivery).
* Ensure compliance with DDP requirements.
* Protect your customers from surprise charges on delivery.
This means your customers get a seamless delivery experience with no surprise costs, while you stay compliant with the new regulations.
---
### Setting up Zonos with Australia Post
Creating a Zonos account is free, although you'll need to add a payment method for customs duties and taxes.
1. Go to [**zonos.com**](https://www.zonos.com) and click **Ship with Australia Post**.
1. Click **Start today**.
2. Fill in the required information to create your account.
3. Add a **payment method** to cover duties and taxes. Zonos will bill this payment method for customs duties, taxes, and postal clearance fees.
4. Depending on your Australia Post setup:
1. **If you use an Australia Post eParcel account:** In **Starshipit**, go to **Settings > Couriers > Australia Post Settings** and copy your **MLID**.
2. **If you use a MyPost Business account:** You’ll need your **Customer Number (APBCN)**. This number is **not in Starshipit** — it’s found in your **MyPost Business portal**
1. Your APBCN will be displayed under your name on the MPB Dashboard, OR
Log in to your MyPost Business account and navigate to your Send & Save page. Your APBCN will be displayed under your unique QR code.
5. Enter the MLID or Customer Number into your **Zonos Dash** to complete the connection.
* **Start shipping through Starshipit**
+ Once connected, you can ship via Starshipit using Australia Post.
+ All duties and taxes will be charged to your Zonos payment method automatically.
#### **About DDP labels with Australia Post**
Other than following the above steps to set up a Verified Zonos account, you don’t need to configure anything in Starshipit or Australia Post to make labels ship on a Delivered Duty Paid (DDP) basis. This happens automatically for all shipments to the United States and is managed by Australia Post.
---
### Before you ship to the US
To continue shipping to the US without disruptions, you must use [DDP](/articles/international-shipping-compliance/customs-duties/configuring-your-shipment-s-ddp-ddu). Zonos provides the link between Australia Post and Starshipit that ensures your shipments are compliant, duties and taxes are handled upfront, and your customers have a smooth experience.
---
# GST regulations for Australia
URL: https://support.starshipit.com/articles/360000338316-gst-regulations-for-australia
Canonical: https://support.starshipit.com/articles/360000338316-gst-regulations-for-australia
Markdown: https://support.starshipit.com/articles/360000338316-gst-regulations-for-australia.md
Updated: 2026-05-06
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Learn how to configure your ABN number in Starshipit for Australian GST compliance when shipping internationally.
* Find out how GST changes in Australia affects your shipping.
* You must complete the Sender ABN number field in Starshipit with the ABN or ARN number of your company if you send more than $75k of merchandise annually.
## About GST regulations for Australia
Using Starshipit, you can now easily provide your ABN number with all of your shipping consignments for both DHL Express and Australia Post.
1. In [Starshipit](https://app2.starshipit.com/), navigate to **Settings** > **Couriers** > **NZ Post/DHL Express Settings** > **Advanced** tab.
2. Complete the **Sender ABN number** field.
You can learn more about GST from the Australian Taxation Office [here](https://www.ato.gov.au/businesses-and-organisations/gst-excise-and-indirect-taxes/gst/registering-for-gst).
---
# Shipping from Australia to the EU
URL: https://support.starshipit.com/articles/8208368199055-shipping-from-australia-to-the-eu
Canonical: https://support.starshipit.com/articles/8208368199055-shipping-from-australia-to-the-eu
Markdown: https://support.starshipit.com/articles/8208368199055-shipping-from-australia-to-the-eu.md
Updated: 2026-05-06
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Learn how to ship from Australia to the EU with proper HS codes and customs pre-approval requirements.
All shipments to the EU require pre-approval from EU customs before the shipment leaves Australia. The pre-approval data needs to include the receiver's postcode as well as the HS tariff code. This applies to all shipments sent to all EU member states, as well as the United Kingdom, Norway and Switzerland.
:::note
Many carriers validate that all data is correct and included when you generate your labels. If you don't include this information, you'll get errors when printing labels for orders heading to the EU.
:::
## How Starshipit manages HS codes
Starshipit automatically imports HS codes for international shipments from many platforms. You can learn about this feature in [our guide](/articles/international-shipping-compliance/customs-duties/set-up-harmonised-system-hs-codes-for-international-shipments). If you’ve already set this up, you won’t need to do anything.
This means if you have already set up HS codes in your Shopify store, you can use them for each SKU.
## How to use Starshipit to automatically submit your customs information
If you don't have HS tariff codes configured in your eCommerce platform, you can use Starshipit’s [Product Catalogue](/articles/integrations/product-catalogue/product-catalogue) to add HS tariff codes to your products. This ensures the destination customs authority automatically receives the information before your item arrives.
Here’s how it works:
1. In Starshipit, navigate to Product.
2. Click **More actions** then select **Download CSV template**.
3. Add your products and their HS codes to the CSV template.
4. Click **Import from CSV**.
5. Click **Select** and choose the CSV file from your computer.
6. Click **Upload**.
---
# GST changes for imports to New Zealand
URL: https://support.starshipit.com/articles/360001264435-gst-changes-for-imports-to-new-zealand
Canonical: https://support.starshipit.com/articles/360001264435-gst-changes-for-imports-to-new-zealand
Markdown: https://support.starshipit.com/articles/360001264435-gst-changes-for-imports-to-new-zealand.md
Updated: 2026-05-06
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Learn how GST changes for imports to New Zealand affect your shipping, including setup for DHL Express, Australia Post, and NZ Post.
If you're shipping low-value goods to customers in New Zealand, you'll need to know about changes to GST on imported goods. The new GST rules came into effect on 1 December 2019.
## About GST changes for imports
From 1 December 2019, new goods and services tax (GST) rules came into effect. Overseas businesses that sell low-value goods to consumers in New Zealand may need to register for, collect, and return GST of 15%.
A low-value good is a physical good valued at NZ$1,000 or less (excluding GST). Some examples of low-value goods may include books, clothing, cosmetics, shoes, sporting items and small electronic items.
Goods imported into New Zealand valued over NZ$1,000 will continue to have GST and customs duties applied at the border.
:::note
You can collect the GST directly on goods greater than NZ$1,000 to save customs collecting it. If you populate the NZ IRD number in DHL Express settings within Starshipit, we assume you collect GST on all goods (not just NZ$1,000 or below), and the customs document will reflect this.
:::
## Who is affected?
These changes apply to:
* Overseas businesses that sell directly to New Zealand consumers online, by phone or mail order.
* Online marketplaces that other people or businesses sell items through.
If the value of goods sold to New Zealand customers exceeds NZ$60,000 over a 12-month period, you'll need to register for, collect, and return New Zealand GST on those sales.
The GST charged at the point of sale is based on the customs value of the goods plus any shipping and insurance charges.
If the changes apply to your business, the legislation requires overseas businesses to:
1. Update their business systems so they can collect and return GST.
2. Register for GST in New Zealand, and collect GST on each good valued at NZ$1,000 or less that is sold to customers and delivered to addresses in New Zealand.
## Shipping with DHL Express
If you ship with DHL Express and the new GST changes apply to you:
1. Go to **Settings** > **Couriers** > **DHL Express**.
2. Select the **Advanced** tab.
3. Fill in the **NZ IRD Number** field (this is an 8 or 9-digit number, with no other characters).
Starshipit will send this number to DHL Express for shipments sent internationally to New Zealand. The number will be shown on the commercial invoice: **OSR: XXXX, GST collected for all contents on sale** (OSR stands for Overseas Supplier Reference, and XXXX will be replaced with your NZ IRD number).
## Shipping with Australia Post
Australia Post has announced that their customs declaration forms (CN22 or CN23 labels) do not need to include any additional information, as the postal channel is *not*required to make changes to labels at this time.
## Shipping with NZ Post
If you ship from overseas to New Zealand and the new GST changes apply to you:
* You are not required to display your IRD number on your shipping label.
* Instead, this must be included in and be captured as part of your electronic manifest for clearance.
If you have any questions around how this applies to you, please speak with your NZ Post account manager.
## Shipping with other couriers
As of 27 November 2019, the following international couriers that ship from overseas to New Zealand have not implemented changes in response to the new legislation:
* Deutsche Post
* DHL eCommerce Asia Pacific
* DHL Parcel Europe
* DHL Parcel UK
* DPD Local
* DPD NL
* DPD UK
* Fastway
* Royal Mail
* Seko
* Singapore Post
* Quantium Solutions
---
# Singapore GST regulatory requirement
URL: https://support.starshipit.com/articles/6100207853327-singapore-gst-regulatory-requirement
Canonical: https://support.starshipit.com/articles/6100207853327-singapore-gst-regulatory-requirement
Markdown: https://support.starshipit.com/articles/6100207853327-singapore-gst-regulatory-requirement.md
Updated: 2026-05-06
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Set up your Singapore OVR number in Starshipit for GST compliance on shipments to Singapore.
* The Government of Singapore announced that the implementation of the Overseas Vendor Registration (“OVR”) regime for Low Value Goods (“LVG”) will take effect from **1st Jan 2023**.
* This means vendors will need to indicate whether the GST is **paid** for items and shipments inbound to Singapore.
* In order to set up your Singapore GST number please follow the below steps. Note: This is currently supported for DHL Express.
## How it works
1. In Starshipit, navigate to **Settings** > **Options** > **Shipper Tax Settings**.
2. In the drop down, select **Singapore GST Collected** and enter your OVR number. Set the **Applicable Destination** as SG (Singapore).
* *Note: When you set up a Singapore tax number **without a rule to indicate false** GST will default as **PAID for all line items.** Ensure that your line items have unique SKUs so that rules run effectively.*
As Singapore requires indication of GST paid per line item you can handle this for DHL Express shipments by using rules.
1. Navigate to **Settings > Rules** and set the below rule based on your currency.
* *Note: Items under SGD 400 should be GST paid and items over SGD 400 should be GST unpaid. You can use an online currency converter to determine the item amount you would like to enter in the rule.*
Your Singapore OVR Number will display on the DHL Express Commercial Invoice. When you set up the above rules, line items will indicate whether GST is paid or unpaid.
---
# Ship to the US: de minimis updates and guidance
URL: https://support.starshipit.com/articles/13607268920207-ship-to-the-us-de-minimis-updates-and-guidance
Canonical: https://support.starshipit.com/articles/13607268920207-ship-to-the-us-de-minimis-updates-and-guidance
Markdown: https://support.starshipit.com/articles/13607268920207-ship-to-the-us-de-minimis-updates-and-guidance.md
Updated: 2026-03-06
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Stay up-to-date on US shipping regulations, de minimis changes, carrier disruption notices, and guidance for shipping to the United States.
From **29 August 2025**, new regulations for shipping into the United States have taken effect. These changes impact how all retailers ship orders to US customers, with stricter compliance requirements and new rules around duties and taxes.
This guide pulls together the key information you need to know and will be updated as carriers release further details.
## What you need to know
* The **de minimis exemption** (previously allowing shipments under $US800 to enter the US duty-free) has been removed. This change went into effect 29 August 2025.
* All duties will now need to be paid by the international mail carrier, or another approved company acting on their behalf, to U.S. Customs. Note that CBP (Customs and Border Protection) has [a certified list of companies](https://content.govdelivery.com/bulletins/gd/USDHSCBP-3f009d0?wgt_ref=USDHSCBP_WIDGET_2) allowed to handle this process.
* **All US shipments now require accurate compliance information** and may attract tariffs or fees, regardless of value.
* Mandatory details for every shipment:
+ [Country of Origin (COO)](/articles/international-shipping-compliance/customs-duties/set-up-country-of-origin-manufacture-for-international-shipments) where the product was manufactured.
+ Accurate Value of Goods must be above $1.00.
+ [HS Tariff Code](/articles/international-shipping-compliance/customs-duties/set-up-harmonised-system-hs-codes-for-international-shipments) required for each item.
* Missing any of these details may result in your shipment being **returned to the sender.**
---
## What you should do next
* **Switch to an express alternate service** (such as DHL Express, FedEx, UPS, SEKO, which will clear customs) if you currently rely on disrupted services for US-bound shipping. Check our carrier updates section below for specific advice as it relates to your carrier.
* **Ensure all shipments** include COO, accurate values, and HS Tariff Codes.
* **Learn more about shipping to the US**, including tariffs, the removal of de minimis and long-term strategies, [in our blog](https://starshipit.com/blog-content/shipping-tariffs).
* **Subscribe to carrier updates** for the latest announcements.
---
## DDP vs DDU
One of the most critical decisions for retailers has always been how duties and taxes are handled:
* **Delivered Duty Paid (DDP)**
You, the retailer, pre-pay duties and taxes. This gives customers a smoother delivery experience, avoiding surprise costs on arrival.
* **Delivered Duty Unpaid (DDU/DAP)**
Your customers pay duties and taxes when the parcel enters the US. While this may reduce your upfront costs, it can result in delivery delays or a poor customer experience.
Our guide covers how to [configure your Starshipit account](/articles/international-shipping-compliance/customs-duties/configuring-your-shipment-s-ddp-ddu) correctly.
---
## Upfront duties and taxes at checkout
Starshipits **Landed Costs** solution lets you display accurate duties and taxes at checkout, collect payment before shipping, and avoid surprise charges at delivery. We handle customs for you and if duties or taxes come in higher than expected, we'll cover the difference.
You can learn more about landed costs [here](https://starshipit.com/shipping-to-the-us).
---
## Carrier updates
Here's the current status for major carriers shipping into the US.
:::note
Tip:We recommend subscribing to updates from your carriers directly to get the latest information. We've added links beneath each carrier section below.
:::
**Australia Post**
Status: US-bound shipments paused from **26 August 2025**.
Notes: Items lodged after this date will be returned to sender. Once resumed, shipments must include COO, Value of Goods, and HS Tariff Codes. Partnering with **Zonos** on a compliance solution. Expected launch: **September 2025**. We've [put together a guide](/articles/couriers/australia-post/shipping-to-the-us-with-zonos-and-australia-post) for how to use this service when it goes live.
Latest updates: [Australia Post Service Updates](https://auspost.com.au/disruptions-and-updates/international-service-updates)
**New Zealand Post**
Status: Some services have reopened.
Notes: Economy, Economy Tracked Economy Plus, and Courier services have reopened. These now send as Delivered Duty Paid (DDP), with duties and taxes charged to your account. $5 admin fee and a 5% disbursement fee per consignment.
Latest updates: [NZ Post Service Updates](https://www.nzpost.co.nz/contact-support/international-delivery-updates)
**DHL Group**
Status: Deutsche Post have paused from **22 August 2025** for US-bound postal shipments. DHL Express and DHL eCommerce operating as normal. For DHL Express and DHL eCommerce, [ensure you've set up DDP](/articles/international-shipping-compliance/customs-duties/configuring-your-shipment-s-ddp-ddu).
Notes: US shipments only possible via **DHL Express** and **DHL eCommerce**.
Latest updates: [DHL Express Service Updates](https://go.freightforwarding.dhl.com/subscribe-service-announcements)
**FedEx**
Status: Operating as normal. [Ensure you've set up DDP](/articles/international-shipping-compliance/customs-duties/configuring-your-shipment-s-ddp-ddu).
Notes: No known disruptions.
Latest updates: [FedEx Updates](https://www.fedex.com/en-au/home.html)
**UPS**
Status: Operating as normal. [Ensure you've set up DDP](/articles/international-shipping-compliance/customs-duties/configuring-your-shipment-s-ddp-ddu).
Notes: New machine learning model for freight quote accuracy. UPS will cover any cost discrepancies.
**SEKO**
Status: Operating as normal. [Ensure you've set up DDP](/articles/international-shipping-compliance/customs-duties/configuring-your-shipment-s-ddp-ddu).
---
# Add and manage account users
URL: https://support.starshipit.com/articles/7630350591247-add-and-manage-account-users
Canonical: https://support.starshipit.com/articles/7630350591247-add-and-manage-account-users
Markdown: https://support.starshipit.com/articles/7630350591247-add-and-manage-account-users.md
Updated: 2026-09-15
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Learn how to invite users to your Starshipit account, assign permissions, and manage team access.
Invite people to your Starshipit account, give them the access they need, and check that their invitation has been sent. You can also remove a user or send them a password-reset link from the same area.
## Before you begin
- Sign in to the parent account. A child account with access only to that child account cannot create users.
- Decide which accounts and permissions the person needs before you invite them.
{{video:youtube:v567Rm8VDug}}
## Invite a user
1. Sign in to [Starshipit](https://app2.starshipit.com/) and go to **Settings** > **Users**.
2. Within the Manage Users section, click **Invite a new user**.
3. Enter the user's email address.
4. In **Permissions**, either set the access for each area or select a predefined role:
- **No access**: The user cannot view or edit the area.
- **Read only**: The user can view the area.
- **Full**: The user can view and edit the area.
- **Customer Service**: The user can access Orders.
- **User**: The user has full access to Orders, Address Book and Manifests.
- **Admin**: The user has full access to all areas.
5. Select which accounts the user should have access to. 
6. Click **Save** to confirm permissions. This will send an invitation email to the user.
## Verify the invitation
Check the **Status** column on the User Management page. The user can use the invitation email to create their password and sign in.
## How to remove a user
1. Login to [Starshipit](https://app2.starshipit.com/) then navigate to **Settings** > **Users**.
2. Select **Edit** next to the user's profile.
3. Click on **Delete user.**
## Reset a password
1. Login to [Starshipit](https://app2.starshipit.com/) then navigate to **Settings** > **Users**.
2. Click **Edit** on the user's profile.
3. Click **Send reset password link** to send the user a new password link email.
---
# Set up single sign-on (SSO)
URL: https://support.starshipit.com/articles/10659444958479-set-up-single-sign-on-sso
Canonical: https://support.starshipit.com/articles/10659444958479-set-up-single-sign-on-sso
Markdown: https://support.starshipit.com/articles/10659444958479-set-up-single-sign-on-sso.md
Updated: 2026-05-07
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Set up Single Sign-On (SSO) to integrate your identity provider with Starshipit for secure, centralised login.
## Why SSO?
Enterprise organisations often have centralised user identity stores and mature processes for managing user access. With our new SSO feature, you can leverage your existing systems, such as Azure Entra ID (formerly Azure AD), Okta, and others, to manage access to our platform. Some of the benefits of using SSO are:
* Full control over user access and security policies, including MFA requirements, password complexity, and access token lifespan.
* Streamlined user onboarding and offboarding processes.
* Enhanced security through centralised management of login events, password resets, and MFA.
* Simplified access management without reliance on third-party support.
## Prerequisites
* You must have users already set up in Starshipit as your identity provider will map to existing accounts.
* The Starshipit account email must be the same as the email address in your identitify provider.
## Set up
To set up Single Sign-On (SSO) with Starshipit, please follow the guides below for submitting your Identity Provider (IDP) and configuring Starshipit as an application.
#### Okta
1. In the Okta dashboard, navigate to **Applications**.
2. Click **Add App.**
3. Select **OIDC** **- OpenID Connect** for the Sign-in method.
4. Select **Web Application** for the Application type.
5. Under **Sign-in redirect URIs,** enter the callback URL provided by Starshipit.
https://auth.starshipit.com/oidc/{your_tenant_name}/callback
Example: https://auth.starshipit.com/oidc/mystore/callback
6. Ensure the scopes openid, profile and email are included.
7. Copy the following values from Okta and send it securely to Starshipit:
1. **Client ID**
2. **Client Secret**
3. **Okta OIDC Issuer URI**
8. Okta provides default claims. If customisation is required, configure these under **Mappings**.
9. Assign users or groups to the application.
#### Auth0
1. In the Auth0 dashboard, navigate to **Applications** > **Create Application**.
2. Select **Regular Web Applications**.
3. Under the **Settings** tab, locate the **Allowed Callbacks URLs field**.
4. Enter the callback URL in the following format:
https://auth.starshipit.com/oidc/{your_tenant_name}/callback
Example: https://auth.starshipit.com/oidc/mystore/callback
5. Ensure the scopes openid, profile and email are included.
6. Copy the following values from Auth0 and send it securely to Starshipit:
1. **Client ID**
2. **Client Secret**
3. **Issuer URI**
7. (Optional) To map additional claims, go to **Rules** or **Actions** and create a rule to modify tokens.
8. Save your settings.
#### Entra ID (Azure Active Directory)
1. In Azure, navigate to **Azure Active Directory** > **App registrations** > **New registration**.
2. Under **Redirect URIs,** enter the callback URL in the following format:
https://auth.starshipit.com/oidc/{your_tenant_name}/callback
Example: https://auth.starshipit.com/oidc/mystore/callback
3. Choose **Web** as the platform.
4. Ensure the scopes openid, profile and email are included.
5. Copy the following values from Entra ID and send it securely to Starshipit:
1. **Client ID**
2. **Client Secret**
To create the application secret:
1. Go to **Certificates & secrets** > Select **New client secret**.
2. In the **Description field**, enter a description/label.
3. Under the **Expires** drop-down field, select a duration.
4. Click **Add** to create the client secret.
3. **Issuer URI**
6. (Optional) If you need to customise your claims, configure these under **Token configuration**.
7. Assign users or groups and configure API permissions as required.
#### Other (Older Identitify Providers that use SAML and LDAP are not supported)
1. In your Identity Provider (IdP) dashboard, navigate to where you can create/manage applications.
2. Create a new application and select **OIDC** or **OpenID Connect** as the protocol.
3. In the application configuration, locate the **Redirect** or **Callback** URL field.
4. Enter the callback URL in the following format:
https://auth.starshipit.com/oidc/{your_tenant_name}/callback
Example: https://auth.starshipit.com/oidc/mystore/callback
5. Ensure the scopes openid, profile and email are included.
6. Copy the following values from Okta and send it securely to Starshipit:
1. **Client ID**
2. **Client Secret**
3. **Issuer URI/Authority**
7. (Optional) Map additional claims as needed.
8. Save your settings.
Once the Starshipit team has enabled SSO for your organisation, you can start using your new SSO auth by logging in via your dedicated login URL e.g. .
Alternatively, you can use the **Continue with SSO** button on the Starshipit login page and enter {your_tenant_name} in the box when prompted for your SSO domain.
:::note
The embedded Shopify app has strict cookie and external authentication provider restrictions. As such, customers wanting to sign in using SSO must use Starshipit in a separate browser tab.
:::
---
# Reset your password
URL: https://support.starshipit.com/articles/115000459046-reset-your-password
Canonical: https://support.starshipit.com/articles/115000459046-reset-your-password
Markdown: https://support.starshipit.com/articles/115000459046-reset-your-password.md
Updated: 2026-09-13
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Learn how to reset your Starshipit password if you've forgotten it or been locked out.
If you have forgotten your password or been locked out after entering it incorrectly, use the Starshipit login page to set a new password.
## Reset a forgotten password
1. Go to the [Starshipit login page](https://app.starshipit.com/Account/MemberLogin.aspx).
2. Click the **Forgot Password?** link.
3. Enter the username you use to log in to Starshipit, then click **Reset Password**.
4. Check the inbox for that username, then open the password-reset email and use its link to set a new password.
5. Return to the login page and sign in with your new password.
## If you cannot find the reset email
Check your junk or spam folder. Make sure you entered the same username you use to sign in, then request another reset email if needed.
---
# General Data Protection Regulation (GDPR) FAQs
URL: https://support.starshipit.com/articles/360000226416-general-data-protection-regulation-gdpr-faqs
Canonical: https://support.starshipit.com/articles/360000226416-general-data-protection-regulation-gdpr-faqs
Markdown: https://support.starshipit.com/articles/360000226416-general-data-protection-regulation-gdpr-faqs.md
Updated: 2026-05-07
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Find answers to frequently asked questions about general data protection regulation (gdpr).
## What is the GDPR?
The General Data Protection Regulation (GDPR) is a comprehensive data protection law that replaces existing European privacy laws and strengthens the protection of personal data. The GDPR is enforceable in each EU member state and gives individuals more control over their personal data.
The aim of the GDPR is to protect all EU citizens from privacy and data breaches in an increasingly data-driven world that is vastly different from the time in which the 1995 directive was established.
Although the key principles of data privacy still hold true to the previous directive, many changes have been proposed to the regulatory policies. The key points of the GDPR, as well as information on the impacts it will have on business, can be found [here](https://gdpr.eu/faq/).
## Does the GDPR apply to me?
The GDPR applies to organisations that process the personal data of EU individuals. So, even if you aren't a company based in the EU, if you sell to customers in the EU, this applies to you.
## What is "personal data"?
Personal data is any information related to a natural person (individual) that can be used to directly or indirectly identify the person. It can be anything from a name or photo to an email address.
## When did it go into effect?
The GDPR came into effect on May 25th, 2018.
## What is Starshipit doing?
Starshipit was compliant with many aspects of the GDPR before it went into effect on May 25th, 2018.
Before the changes came into effect, we updated our Privacy Policy and Terms of Service. If it's applicable to you and your customers, we added information on how to exercise rights around your data and how to control the use of your personal information through our services. Before you enter the Personal Data of European Union Data Subjects into our software to use our services, you are obliged to be in compliance with the GDPR and get the affirmative consent of your customers according to our [Terms of Service](https://app.starshipit.com/Account/Terms.aspx)and [Privacy Policy](https://www.starshipit.com/privacy-policy).
## What do I do if my customer wants their data deleted?
If your customer wants their data deleted, please contact our support team [here](https://help.starshipit.com) and we will delete all data at our end too.
## What do I need to do to ensure I am GDPR-compliant?
For more information on the EU GDPR policies and how to ensure you are compliant, visit [www.eugdpr.org](https://gdpr.eu/).
---
# Compare Starshipit pricing plans
URL: https://support.starshipit.com/articles/360000988135-compare-starshipit-pricing-plans
Canonical: https://support.starshipit.com/articles/360000988135-compare-starshipit-pricing-plans
Markdown: https://support.starshipit.com/articles/360000988135-compare-starshipit-pricing-plans.md
Updated: 2026-05-07
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Compare Starshipit pricing plans from Starter to Enterprise and find the right fit for your shipping volume.
## 30-day free trial
You receive a 30-day free trial when you first [sign up](https://app.starshipit.com/Dashboard/Wizard.aspx) for Starshipit. No credit card details are required for the free trial. During the free trial, our technical customer success team will be on hand to help you integrate your platforms and couriers, all for free!
Once your free trial ends, you will need to select a pricing plan based on your volume during the free trial.
## Pricing plan
:::note
All prices stated are Australian Dollars
:::
### Starter
Recommended for customers with up to 100 shipments per month.
$45/month paid annually or $50/month paid month to month.
* Unlimited integrations with the following types of platforms:
+ E-commerce
+ Marketplace
+ Sales & marketing
+ Accounting
+ Customer support & helpdesk
* Integrate with up to 2 couriers.
* Up to 3 rules.
* 2 users.
* Note: Multi-location/multi-brand accounts are available as an add-on ($25).
###
### Starter Plus
Recommended for customers with up to 500 shipments per month.
$125/month paid annually or $140/month paid month to month.
**Including all Starter features, as well as:**
* 5 users.
###
### Professional
Recommended for customers with up to 1,000 shipments per month.
$180/month paid annually or $200/month paid month to month.
**Including all Starter Plus features, as well as:**
* Product catalogue
* Packing validation
* Recommended packaging
* Unlimited integrations with the following types of platforms:
+ Inventory management
* Integrate with up to 4 couriers.
* Up to 5 rules.
* 5 users.
* Note: Multi-location/multi-brand accounts are available as an add-on ($25) on all plans with up to 2 accounts included in this plan.
* Note: Live rates at checkout is available as an add-on ($30)
* Note: Branded returns portal is available as an add-on ($20)
###
### Professional Plus
Recommended for customers with up to 5,000 shipments per month.
**Including all Professional features:**
* $270/month paid annually or $300/month paid month to month.
* 10 users.
###
### Enterprise
Recommended for customers with up to 10,000 shipments per month.
$495/month paid annually or $550/month paid month to month.
**Including all Professional Plus features, as well as:**
* Live rates at checkout
* Branded returns portal
* Single sign-on (SSO)
* Unlimited integrations with the following types of platforms:
+ WMS
+ ERP
* Unlimited couriers.
* Unlimited rules.
* Unlimited users.
* Multi-location/multi-brand accounts are available as an add-on (custom quote) on all plans with up to 3 accounts included in this plan.
### Custom
If you ship over 10,000 shipments a month, please get in touch with our team for a [custom quote](https://www.starshipit.com/contact-sales).
---
# Explore Starshipit add-ons
URL: https://support.starshipit.com/articles/12080147770127-explore-starshipit-add-ons
Canonical: https://support.starshipit.com/articles/12080147770127-explore-starshipit-add-ons
Markdown: https://support.starshipit.com/articles/12080147770127-explore-starshipit-add-ons.md
Updated: 2026-07-16
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Explore Starshipit add-ons like Live Rates, Branded Returns, Pick & Pack, and multi-location accounts.
## Add-ons
#### Live rates at checkout
| | | | |
| --- | --- | --- | --- |
| **Plan** | Starter | Professional | Enterprise |
| | $30 per month | $30 per month |  |
Configure [live rates at checkout](/articles/rates-at-checkout/set-up-guides/about-live-rates-at-checkout-supported-couriers) to show customers real-time shipping costs before they finalize their order. Starshipit will fetch and display the best options from our partner couriers.
With live rates, Starshipit will return your negotiated contract rates at checkout, provided electronically by your courier company.
#### Branded customer returns portal
| | | | |
| --- | --- | --- | --- |
| **Plan** | Starter | Professional | Enterprise |
| | $20 per month | $20 per month |  |
The [branded customer returns portal](/articles/returns/branded-returns-portal/set-up-branded-returns-portal) allows you to create and embed a branded self-service returns portal directly onto your website.
With a customer-facing/self-service returns portal, you can simplify and automate your entire returns process, allowing customers to self-service, track their returns and feel confident making purchases with you.
#### Pick & Pack mobile app
| | | | |
| --- | --- | --- | --- |
| **Plan** | Starter | Professional | Enterprise |
| | $100 per month | $100 per month | $100 per month |
The [Starshipit Pick & Pack mobile app](/articles/90200000000301-choose-the-right-starshipit-mobile-app) helps retailers speed up fulfilment by allowing you to scan, pick, pack and print directly from your mobile device. It is separate from Starshipit WMS Mobile.
What's included in the mobile app:
* The app streamlines fulfilment workflows by helping warehouse and in-store teams:
* View and manage unshipped orders
* Scan and validate items using barcodes
* Pick and pack orders accurately
* Trigger label printing and update order status
* Capture proof-of-packaging photos (optional)
#### Multi-location/multi-brand accounts
| | | | |
| --- | --- | --- | --- |
| **Plan** | Starter | Professional | Enterprise |
| | Add-on required* | 2 free accounts* | 3 free accounts* |
Streamline your shipping operations by utilizing child accounts, which allow you to create sub-accounts under your main account, enabling seamless management of shipments across multiple different brands and locations.
* [Child accounts](/articles/360000553016)
* [Managing multi-location, multi-brand, and dropshipping](/articles/360001188356)
*Multi-location/multi-brand accounts are available as an add-on ($25) on all plans with up to 2 accounts included in the Professional plan and 3 in the Enterprise plan.
## How to enable an add-on
1. Click the **account name drop-down** in the top right corner of the dashboard.
2. Click **Manage account** then click your current plan to access Subscription Details.
3. Click **Edit Subscription**.
4. Click on the **Add Addons** button.
5. Click the check box next to an add-on to enable it.
6. Click **Add**to include the add-on(s) to your subscription.
7. Click **Update Subscription** to save your changes.
## How to remove or cancel an add-on
1. Go to [My Account](https://app2.starshipit.com/account).
2. In the **Add-ons** section, untick the add-on you want to remove.
3. Click **Save**.
The add-on will be removed and cancelled from your account.
---
# Change your pricing plan
URL: https://support.starshipit.com/articles/206705123-change-your-pricing-plan
Canonical: https://support.starshipit.com/articles/206705123-change-your-pricing-plan
Markdown: https://support.starshipit.com/articles/206705123-change-your-pricing-plan.md
Updated: 2026-05-07
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Learn how to change, upgrade, or downgrade your Starshipit pricing plan at any time.
{{video:youtube:0lITE9Uoz94}}
## About changing your pricing plan
When you first register with Starshipit, you'll receive a 30-day free trial that gives you access to all features (except child accounts). If you decide to continue past your free trial period and [select a paid plan](https://starshipit.com/pricing), you'll be charged a monthly or annual subscription fee depending on the plan you select. When you choose a plan you'll be billed straightaway for the plan duration.
Starshipit allows you to change between plans at any time. You can upgrade, downgrade, switch from monthly to annual, or annual to monthly at any point you'd like.
* If you downgrade, you'll be credited pro rata any credit you may accrue from the downgrade.
* If you upgrade, the current value will be deducted from the cost of the upgrade.
Any remaining pro-rata credit will remain in your Starshipit account for you to use at a later date. Unfortunately, we're unable to refund you any credit you have that may reside in your Starshipit account.
## Enter your payment method
If you are signing up for a plan for the first time you will need to add a payment method before choosing a plan. We accept payments via VISA, MasterCard, AMEX and PayPal. We do not support Afterpay.
1. Log in to [Starshipit](https://app.starshipit.com/Account/MemberLogin.aspx)
2. Navigate to **Settings,** then select [My Account](https://app.starshipit.com/Members/Settings/MyAccount.aspx).
3. Click **Manage Account.**
4. Click **Payment Methods,** and enter your credit card details, then click **Add**.
5. Choose your plan per the **Choose a new pricing plan** steps below.
1. Log in to Starshipit
2. Use the drop down menu in the top right hand corner and click [Manage Account.](https://app2.starshipit.com/account)
3. Click **Manage Account.**
4. Click **Payment Methods,** and enter your credit card details, then click **Add**.
5. Choose your plan per the **Choose a new pricing plan** steps below.
## Choose a new pricing plan
1. Log in to [Starshipit](https://app.starshipit.com/Account/MemberLogin.aspx)
2. Navigate to **Settings,** then select [My Account](https://app.starshipit.com/Members/Settings/MyAccount.aspx).
3. Click **Manage Account**.
4. Select a [pricing plan](https://starshipit.com/pricing), and choose to pay on a monthly or annual basis.
5. Click **Update your Plan**.
6. Click **Proceed to Checkout**.
7. Add your account and payment details.
8. Once the payment is complete, your plan should now be updated.
1. Log in to [Starshipit](https://app2.starshipit.com/).
2. Use the drop down menu in the top right hand corner and click [Manage Account](https://app2.starshipit.com/account).
3. Click **Update your plan**.
4. Select a [pricing plan](https://starshipit.com/pricing), and choose to pay on a monthly or annual basis.
5. Click **Update your Plan**.
6. Click **Proceed to Checkout**.
7. Add your account and payment details.
8. Once the payment is complete, your plan should now be updated.
If you enter your card details and you're currently on a trial plan with trial days remaining, these will be added to your chosen plan.
## Upgrade your pricing plan
If you’re nearing your monthly shipment limit, we’ll notify you via email and in-app. If you exceed your limit, you have two options:
1. Pay per-label overage fees – Additional labels will be charged based on your plan:
* **Starter**: $0.15 per additional label
* **Professional**: $0.10 per additional label
* **Enterprise**: Contact sales for custom pricing
2. Upgrade to a higher-tier plan – Increase your shipment volume and gain access to additional features.
You can manage your plan and review pricing details in your account settings at any time.
## Reviewing your plan ahead of peak season
During peak season (e.g. Black Friday/Cyber Monday), you may find that your shipping demands increase significantly. During this period, many businesses find themselves exceeding their monthly label quotas due to higher order volumes. If your label volume exceeds the limit set by your current plan, it may result in delays and disruptions in your shipping operations, impacting your ability to fulfill customer orders on time.
By reviewing and adjusting your plan ahead of peak season, you can ensure that you have the right capacity to handle the increase in shipments. This proactive step helps you avoid unexpected issues and ensures that your operations run smoothly throughout this critical period. If needed, you can easily upgrade your plan following the steps provided in the [Choose a new pricing plan](#h_01HMYHWFD10DGW5DADQWASR8FM) section to accommodate your growing shipping needs.
Staying ahead of potential disruptions will allow you to focus on delivering a seamless experience for your customers during the busiest time of the year.
---
# Add or change a payment method
URL: https://support.starshipit.com/articles/4405883176591-add-or-change-a-payment-method
Canonical: https://support.starshipit.com/articles/4405883176591-add-or-change-a-payment-method
Markdown: https://support.starshipit.com/articles/4405883176591-add-or-change-a-payment-method.md
Updated: 2026-05-07
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Learn how to add or update your payment method in Starshipit, including credit cards and PayPal.
{{video:youtube:0lITE9Uoz94}}
## Enter your payment method
If you are signing up for a plan for the first time, your card has expired or you would like to change payment method, please see our steps below. We accept payments via debit and credit cards - VISA, MasterCard, AMEX and PayPal.
We do not support any buy now pay later methods such as Afterpay.
1. Log in to Starshipit.
2. Navigate to **Settings,** then select My Account.
3. Click **Manage Account.**
4. Click **Payment Methods,** and enter your credit card details, then click **Add**.
For Paypal payments, you will be redirected to authenticate your Paypal account before returning to Starshipit.
5. Choose your plan.
1. Log in to Starshipit.
2. Use the drop-down menu in the top right-hand corner and click **Manage Account**.
3. Click **Manage Account.**
4. Click **Payment Methods,** and enter your credit card details, then click **Add**.
For PayPal payments, you will be redirected to authenticate your PayPal account before returning to Starshipit.
5. Choose your plan.
---
# View and download your Starshipit invoices
URL: https://support.starshipit.com/articles/360001658036-view-and-download-your-starshipit-invoices
Canonical: https://support.starshipit.com/articles/360001658036-view-and-download-your-starshipit-invoices
Markdown: https://support.starshipit.com/articles/360001658036-view-and-download-your-starshipit-invoices.md
Updated: 2026-05-07
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Learn how to access and download your Starshipit invoices from your account settings.
{{video:youtube:0lITE9Uoz94}}
## Access your Starshipit invoices
1. Log into your Starshipit [account](https://app.starshipit.com/Account/MemberLogin.aspx).
2. Go to **Settings** > **My Account.**
3. Click on **Manage Account**
4. Click **Billing History** to view your invoices.
1. Log into your Starshipit [account](https://app.starshipit.com/Account/MemberLogin.aspx).
2. Select the drop-down arrow next to your username in the top right corner then select **Manage Account.**
3. Click on the **Manage Account** button.
4. Click **Billing History** to view your invoices.
## If you can't see Billing History
If **Billing History** is not visible, check the following:
* Confirm you are logged in as a user with access to account and billing settings.
* If your subscription is managed through Shopify, your billing may be managed by Shopify rather than Starshipit.
* If you use child accounts, check whether the invoice is stored against the parent billing account.
* If you have recently moved between Classic UI and UI 2.0, try the steps for both interfaces above.
If you still can't access the invoice, contact our [support team](https://help.starshipit.com) with the billing period or invoice you are looking for.
---
# Change your invoice email contact
URL: https://support.starshipit.com/articles/4498768256911-change-your-invoice-email-contact
Canonical: https://support.starshipit.com/articles/4498768256911-change-your-invoice-email-contact
Markdown: https://support.starshipit.com/articles/4498768256911-change-your-invoice-email-contact.md
Updated: 2026-02-12
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Learn how to change the email address that receives your Starshipit invoices.
## Update your invoice contact
Log in to your Starshipit account and access your Account settings:
1. Click **Settings** in the top navigation menu.
2. From the dropdown, select **My Account.**
3. Click **Manage Account** under Current plan details.
4. Click **Billing & Shipping Addresses.**
5. Select and update your email.
6. Click **Update** to save your changes.
1. Click your account name in the top right corner of the dashboard.
2. Choose **Manage Account** from the dropdown.
4. Click **Billing & Shipping Addresses.**
5. Select and update your email.
6. Click **Update** to save your changes.
---
# Understand what happens when you exceed your plan
URL: https://support.starshipit.com/articles/12102602688015-understand-what-happens-when-you-exceed-your-plan
Canonical: https://support.starshipit.com/articles/12102602688015-understand-what-happens-when-you-exceed-your-plan
Markdown: https://support.starshipit.com/articles/12102602688015-understand-what-happens-when-you-exceed-your-plan.md
Updated: 2026-02-12
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Exceeding your shipment limit & managing your plan Your Starshipit plan includes a set number of shipments per month. If you’re getting close to that limit — or you’ve already exceeded it — here’s wha...
Your Starshipit plan includes a set number of shipments per month. If you’re getting close to that limit or you’ve already exceeded it, here’s what happens and how to manage your plan.
### What happens if you exceed your plan limit?
You’ll get notified:
* **In-app** when you're nearing your limit
* **Via email** when you’re close or over
If you go over your monthly shipment allowance, you won’t be blocked — instead, you’ll be charged a small **per-label overage fee**:
| Plan | Overage fee per label |
| --- | --- |
| Starter | $0.15 |
| Professional | $0.10 |
| Enterprise | Contact us for custom pricing |
If you’re consistently exceeding your limit — or want access to more features — you can upgrade to a higher plan at any time.
You’ll get:
* A higher monthly shipment allowance
* Additional platform features (depending on the plan)
You’re in control — upgrade when it makes sense for your business.
### How to manage or change your plan
You can update your subscription at any time from within your Starshipit account.
1. Log in to Starshipit.
2. Navigate to **Settings** then select **My Account**.
3. Click **Manage Account**
4. Click your current plan to access **Subscription Details**.
5. Click **Edit Subscription**.
6. Select a [pricing plan](https://starshipit.com/pricing), and choose to pay on a monthly or annual basis.
7. Click **Update Subscription**.
8. Click **Subscription Details** to go back to the main billing page.
9. Click **Exit** to go back to Starshipit.
1. Log in to Starshipit.
2. Use the drop-down menu in the top right-hand corner and click Manage Account.
3. Click **Manage Plan and Account Details**.
4. Click your current plan to access **Subscription Details**.
5. Click **Edit Subscription**.
6. Select a [pricing plan](https://starshipit.com/pricing), and choose to pay on a monthly or annual basis.
7. Click **Update Subscription**.
8. Click **Subscription Details** to go back to the main billing page.
9. Click **Exit** to go back to Starshipit.
---
# Reactivate your Starshipit account
URL: https://support.starshipit.com/articles/4405883270031-reactivate-your-starshipit-account
Canonical: https://support.starshipit.com/articles/4405883270031-reactivate-your-starshipit-account
Markdown: https://support.starshipit.com/articles/4405883270031-reactivate-your-starshipit-account.md
Updated: 2026-05-07
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> If your account has been canceled due to a failed payment or being put. on hold, you can reactivate it at any time. Confirm that you have a payment method/articles/settings-billing-security/billing/...
If your account has been canceled due to a failed payment or being put on hold, you can reactivate it at any time.
1. Confirm that you have a [payment method](/articles/settings-billing-security/billing/changing-or-adding-a-new-payment-method) entered on your Starshipit account.
2. On the **Manage Subscriptions** page, click on your plan.
3. Click on **Edit Subscription** and select the plan that you'd like to use.
4. Click **Reactivate Subscription** > **Confirm**.
5. Your account will now be reactivated!
---
# Cancel your Starshipit subscription
URL: https://support.starshipit.com/articles/115000438783-cancel-your-starshipit-subscription
Canonical: https://support.starshipit.com/articles/115000438783-cancel-your-starshipit-subscription
Markdown: https://support.starshipit.com/articles/115000438783-cancel-your-starshipit-subscription.md
Updated: 2026-05-07
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Learn how to cancel your Starshipit subscription.
## How it works
You must cancel your account before the renewal date of your subscription. If you don't cancel before this date, your subscription will be automatically renewed.
You can view the details of your current plan under **My Account** (Classic UI) or **Manage account** (UI 2.0).
## How to cancel your subscription
1. Log in to your Starshipit account.
2. Click **Settings**.
3. Select **My Account**.
4. Under **Account Details**, click **Manage Account**.
5. Locate your current plan and click its name.
6. Click **Cancel Subscription**.
7. Select a cancellation reason from the options provided.
8. If you have any additional feedback, feel free to share it.
9. Click **Confirm Cancellation**.
1. Log in to your Starshipit account.
2. Click the dropdown menu next to your account name on the top right of the dashboard.
3. Select **Manage account** from the dropdown.
4. Locate your current plan and click its name.
5. Click **Cancel Subscription**.
6. Select a cancellation reason from the options provided.
7. If you have any additional feedback, feel free to share it.
8. Click **Confirm Cancellation**.
:::note
Your subscription remains active until the end of your paid period, allowing continued access to Starshipit.
:::
## Uninstalling via Shopify (if applicable)
If you use Shopify and can't find the "Cancel Account" option:
1. From your Shopify admin page, click **Settings** > **Apps and sales channels**.
2. In the row with the Starshipit app, click **Uninstall**.
3. After a message appears, click **Uninstall**.
4. This action will initiate the cancellation process.
#### Need help? Reach out to us
If you encounter any issues or need assistance, don't hesitate to contact our support team [here](https://help.starshipit.com). We're here to help you through the process.
---
# Billing FAQs
URL: https://support.starshipit.com/articles/8512957552143-billing-faqs
Canonical: https://support.starshipit.com/articles/8512957552143-billing-faqs
Markdown: https://support.starshipit.com/articles/8512957552143-billing-faqs.md
Updated: 2026-05-06
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Find answers to frequently asked questions about billing, subscriptions, refunds, and plan management.
Is a refund available for monthly subscription plans?
For monthly subscriptions refunds are not available. Subscriptions can be managed autonomously via the self-service portal. Giving flexibility to switch between plans as needed and manage the subscriptions.
Can I receive a refund on my annual subscription?
For annual subscriptions, prorated credits are available. This is calculated by deducting the equivalent monthly rate for the period used from the total annual fee, crediting the remainder. For example, if three months have been utilised, the credit will be calculated based on the monthly subscription fee, and the total credit will be the balance for the remaining nine months.
Any remaining pro-rata credit will remain in your Starshipit account for you to use at a later date - a credit will be applied and automatically offset against any future invoices. Unfortunately, we're unable to refund you any credit you have that may reside in your Starshipit account.
(Please be advised that some Enterprise Plus accounts may be subject to specific contractual terms that may come with restrictions. We encourage you to consult any additional contractual clauses for further details)
What happens when I use more labels than my plan allows?
Exceeding the label count on your current plan will restrict access to Starshipit services, including label printing and live rate generation. To continue using Starshipit, you'll need to upgrade your plan. This can be done instantly by navigating to Settings > My Account and selecting a new plan from the dropdown menu.
Can I upgrade my plan?
You have the flexibility to upgrade or downgrade your plan at any time with Starshipit. To change your plan:
1. Go to **Manage Plan** > **Account Details.**
2. Click the **Manage account**button.
3. Select Subscription Details to view your current plan.
4. Pick a new pricing plan and select monthly or annual payment.
5. Update your Subscription.
6. Return to the main billing page and exit back to the main Starshipit interface.
7. Your account will be adjusted accordingly, with any downgrades resulting in pro-rated credit to your account, and upgrades being offset by the current plan's value.
I'm only going over my label limit this month. Do I still need to upgrade?
If your label usage exceeds the monthly limit, an upgrade is necessary to maintain service continuity. Starshipit's plan flexibility allows for subscription upgrades during higher volume periods, with the option to downgrade when usage decreases, ensuring you pay according to your business needs.
When does billing rollover?
Billing rolls over at 11:59 PM on the day of renewal in the UTC time zone.
For example, if you're due for a renewal at **11:59 PM** on **July 13th UTC**, this would be **11:59 AM** on **July 14th New Zealand Time**.
Are there any discounts if I switch to an annual plan?
Yes, you'll receive a discount compared to the monthly rate when you switch to an annual plan. Please visit our pricing page for further information on subscription pricing
How can I update my payment information?
1. Log in to [Starshipit](https://app.starshipit.com/)
2. Navigate to **Settings,** then select **My Account**
3. Click **Manage Account.**
4. Click **Payment Methods,** and enter your credit card details, then click **Add**.
For Paypal payments, you will be redirected to authenticate your Paypal account before returning to Starshipit.
5. Choose your plan.
1. Log in to [Starshipit](https://app2.starshipit.com/)
2. Use the drop down menu in the top right hand corner and click **Manage Account**
3. Click **Manage Account.**
4. Click **Payment Methods,** and enter your credit card details, then click **Add**.
For Paypal payments, you will be redirected to authenticate your Paypal account before returning to Starshipit.
5. Choose your plan.
Where can I find my invoices?
You can view and download your invoices by navigating to Settings > My Account > Manage Account > Billing History in your account. Just click 'download' next to the billing period you need the invoice for.
Is it possible to pay by invoice?
We require payment by credit/debit card or Paypal and do not support invoice payments. This method ensures flexibility for any plan changes you might need to make throughout the year.
Are there any plans between Starter and Starter Plus?
Currently, we do not offer any plans situated between the Starter and Starter Plus levels.
How do I cancel my subscription?
We're sorry to hear you're leaving. To cancel your subscription, go to Settings > My Account > Manage Account, click on your current plan name, and then select 'Cancel Subscription.'
Is it possible to pause my account?
Yes, you can pause your account. To do this, navigate to Settings > My Account > Manage Account, click on your plan name, and then choose 'Cancel Subscription.' Your account setup will be retained, and you can reactivate your subscription at any time by following the same steps and selecting 'Reactivate Subscription.'
How do I change my Shopify plan?
:::note
When making a change to your plan, please make sure you are logged into Starshipit via a web browser.
:::
1. Log in to [Starshipit](https://app.starshipit.com/)
2. Navigate to **Settings,** then select **My Account**
3. Under **Choose new plan**, select the plan you'd like to use.
4. Click **Save**. This should redirect you to Shopify.:** Ensure that you are already logged in to Shopify**
5. Authorize the change.
1. Log in to [Starshipit](https://app2.starshipit.com/)
2. Use the drop down menu in the top right hand corner and click **Manage Account**
3. Under **Choose new plan**, select the plan you'd like to use.
4. Click **Save**. This should redirect you to Shopify.:** Ensure that you are already logged in to Shopify**
5. Authorize the change.
How can I update the email address for my invoice notifications?
To update billing email address, in the app go to Settings > Manage Plan and Account Details. Click on 'Billing & Shipping Addresses' to change the billing email and other contact details.
Can I change my billing address?
To update your billing address, log in to your account, visit Settings > Manage Plan and Account Details, and click on 'Billing & Shipping Addresses.' Here, you can modify the address used for billing purposes.
What happens if I upgrade my plan mid-billing period?
When you change your plan mid-billing period, the pro-rated balance from your current plan is applied as a credit for this amount towards the cost of the upgrade. If you downgrade, the remaining value of your current plan will be credited to your account for the next billing period.
Can I get a refund for unused credits?
Currently, we do not offer refunds for unused credits. Any credits you accumulate are automatically applied to your next invoice.
Can my child accounts and main account be billed separately?
Billing for child accounts and the main account is consolidated under one account. This structure is in place to provide a discount compared to maintaining separate accounts for each.
Is it possible to restart a trial?
The option to restart a trial is evaluated on a case-by-case basis. Please contact your Customer Success Specialist to discuss your specific situation and explore available options.
Which currency are plans charged in?
All plans are charged in Australian dollars.
What is your refund policy?
If you have a monthly plan you can cancel at any time, we do not offer refunds for monthly plans. If you are on an annual plan we will happily provide a prorated refund, for any unused period.
Will we be charged when our trial is up?
Subscription charges are applied at the time of selecting a plan after the 30-day free trial period.
How does Starshipit handle shipping rates?
Starshipit provides a couple of options for shipping rates to suit all ages and stages, you can either BYO courier accounts to leverage your own negotiated discounts and we won't penalise or charge you extra for doing so!
Alternatively, we have instant access rates via a range of plug and play solutions where the couriers charge directly to your credit card. Most plug and play solutions offer discounts based on volume. Great for smaller retailers.
---
# Choose an account structure for multiple locations or 3PL clients (child accounts)
URL: https://support.starshipit.com/articles/360000553016-choose-an-account-structure-for-multiple-locations-or-3pl-clients-child-accounts
Canonical: https://support.starshipit.com/articles/360000553016-choose-an-account-structure-for-multiple-locations-or-3pl-clients-child-accounts
Markdown: https://support.starshipit.com/articles/360000553016-choose-an-account-structure-for-multiple-locations-or-3pl-clients-child-accounts.md
Updated: 2026-05-07
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Choose the right linked-account structure for multiple workstations, locations, brands, or 3PL clients.
Use linked Starshipit accounts when you need a separate account boundary for another location, brand, 3PL client, or workstation login. Starshipit calls these linked sub-accounts **child accounts** in the app, and calls the main account the **parent account**.
You do not need a child account just because you have more than one printer. A Starshipit account can route print jobs to Desktop App machines, and each machine has its own local printer mappings. See [how Starshipit printing works](/articles/90200000000155-understand-how-starshipit-printing-works).
## How it works
Child accounts are attached to your parent Starshipit account. A child account can have different couriers, integrations, pickup addresses, and other settings.
There are four types of child accounts:
#### Multi-workstation
Use this when separate staff or stations need their own linked Starshipit login while working with the parent account's orders. Do not use it only to select a different physical printer: printer selection is handled by the account's machine route and each Desktop App's local printer mappings.
#### Multi-location
Use this when you are shipping from two or more physical locations. Your multi-location child account has access to all courier accounts, print settings, and sender addresses. Customer notifications, branding and integrations are inherited from your parent account. Rules can be used to assign orders from your parent account to the child account. Orders which are fulfilled on these child accounts will write-back via the parent account.
#### Multi-3PL
Use this when you are shipping from one location but you have multiple client accounts with their own settings. The parent account ships orders from all child accounts by overriding the accounts. Pricing is hidden on each child account (optional) and the user will not be able to access courier settings.
#### Full access
Each child account has full access to their settings.
---
# Set up an account for a location, brand, or 3PL client (child accounts)
URL: https://support.starshipit.com/articles/360001575375-set-up-an-account-for-a-location-brand-or-3pl-client-child-accounts
Canonical: https://support.starshipit.com/articles/360001575375-set-up-an-account-for-a-location-brand-or-3pl-client-child-accounts
Markdown: https://support.starshipit.com/articles/360001575375-set-up-an-account-for-a-location-brand-or-3pl-client-child-accounts.md
Updated: 2026-05-07
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Create or link an account for another location, brand, workstation, or 3PL client.
Create a linked account when another location, brand, workstation, or 3PL client needs separate settings. Starshipit calls linked sub-accounts **child accounts** in the app.
## Set up a new child account
If the account does not already exist in Starshipit, create and link it to your main account.
1. Log into the [Starshipit app](https://app2.starshipit.com/).
2. Navigate to **Settings** > **Child Accounts**.
3. Click **Add a new child account**.
4. Select the child account type and fill in the username and password.
*Not sure what to use as the username? Read our tips [here](#h_01JCMANGDCQ1YHRWDQNB9JMTBP).*
5. Click **Save**.
:::note
Learn more about the different types of child accounts [here](/articles/360000553016).
:::
## Link an existing account
If you want to convert a parent account/existing account to a child account you can by following these steps
1. Log into the [Starshipit app](https://app2.starshipit.com/).
2. Navigate to **Settings** > **Child Accounts**.
3. Click **Link an existing standalone account**.
4. Enter the username and password for the existing account.
5. Select the child account type.
6. Click **Save**.
#### Re-linking an expired standalone account as a child account
If you're linking a previously expired standalone account (e.g. an account you've removed and later added again), the account may initially display as having an **Invalid plan** status.
To resolve this:
1. In Starshipit, go to **Settings** > **My Account**/**Manage account**.
2. Click the **Re-sync them here** link.
This will immediately refresh the connection and update the plan status. While the system may automatically re-sync accounts overnight, using the manual option allows you to start using the account straight away.
:::note
Learn more about the different types of child accounts [here](/articles/360000553016).
:::
## Tips for child account usernames
* Usernames aren't case sensitive (capitals don't matter), and they can include spaces but special characters aren't allowed.
* Make the username easily identifiable, especially if you have a lot of child accounts.
* Follow a consistent structure. For example:
+ [Location]-[Company Name] (e.g., George Street-My Store)
+ [Brand]-[Parent] (e.g., MyBrand-OnlineDist)
* You can use email addresses as a child account's username.
*This is required if you need a subscription key to be generated automatically.*
* Consider what works best for you as every business is set up uniquely.
## Account settings
* **Hide Courier Rates:** Select this option to hide courier rates on the child account's order details page. This option is not available for multi-workstation accounts.
* **Inherit Address Book:** Choose this option to enable the child account to copy address book settings from your main account. This option is available only for multi-location accounts.
* **Copy Carrier Account Settings from Parent Account:** Enable this setting to copy the carrier settings from your main account to the newly created child account.
* **Allow Access to Manifests Page:** Selecting this will hide access to the manifest page for the child account. This option is applicable when editing a 3PL child account.
### **What's Next?**
Read more about [child accounts](/articles/360000553016), and [how to allocate orders to a child account](/articles/115001657023).
---
# Switch between linked accounts (child accounts)
URL: https://support.starshipit.com/articles/360001580456-switch-between-linked-accounts-child-accounts
Canonical: https://support.starshipit.com/articles/360001580456-switch-between-linked-accounts-child-accounts
Markdown: https://support.starshipit.com/articles/360001580456-switch-between-linked-accounts-child-accounts.md
Updated: 2026-05-07
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Switch from a main Starshipit account to a linked account or sign in to it directly.
Switch from your main Starshipit account to a linked account when you need to manage that location, brand, workstation, or 3PL client. Starshipit calls this linked sub-account a **child account** in the app.
## Override access to a child account
You can log into a child account by first logging into the parent account, and then overriding the child account. The parent account can then cancel the override and go back to seeing their parent account orders – or override another child account.
#### UI 2.0
1. Log in to your parent Starshipit account.
2. From the dashboard, click your username in the top right.
3. From the dropdown menu that appears, click **Switch accounts**.
4. Locate the child account you wish to override, and click the **Switch** button.
5. Only child accounts that are linked to the parent account can be accessed from here. Find out how to set up a child account [here](/articles/360001575375).
#### Classic UI
1. Log in to your parent Starshipit account.
2. From the dashboard, click your username in the top left.
3. Select your child account from the list.
4. Only child accounts that are linked to the parent account can be accessed from here. Find out how to set up a child account [here](/articles/360001575375).
## Log in directly
You can log in to a child account directly using its username and password. By using this method, the child account won't be able to access other child accounts or parent account resources.
This direct login method is ideal for restricting warehouse staff who will be using the child account, as they won't be able to access other child accounts or the parent account. They will only be able to access the orders and settings on the account they are logging into.
---
# Unlink a connected account (child account)
URL: https://support.starshipit.com/articles/4414129951631-unlink-a-connected-account-child-account
Canonical: https://support.starshipit.com/articles/4414129951631-unlink-a-connected-account-child-account
Markdown: https://support.starshipit.com/articles/4414129951631-unlink-a-connected-account-child-account.md
Updated: 2026-05-07
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Disconnect a linked account from the main Starshipit account.
Unlink a connected account when it should no longer sit under your main Starshipit account. Starshipit calls linked sub-accounts **child accounts** in the app.
## Unlink a child account
1. In Starshipit, navigate to **Settings**> **Child accounts**.
2. Click **Edit** next to the child account you would like to unlink.
3. Click **Unlink User**.
4. The user is now unlinked.
---
# Multi-location and 3PL account FAQs (child accounts)
URL: https://support.starshipit.com/articles/8305064800655-multi-location-and-3pl-account-faqs-child-accounts
Canonical: https://support.starshipit.com/articles/8305064800655-multi-location-and-3pl-account-faqs-child-accounts
Markdown: https://support.starshipit.com/articles/8305064800655-multi-location-and-3pl-account-faqs-child-accounts.md
Updated: 2026-05-06
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Find answers about linked account types, access, billing, reporting, and order processing.
These FAQs explain linked account types, access, billing, reporting, and order processing. Starshipit calls linked sub-accounts **child accounts** in the app.
What is the difference between Full Access, 3PL, Multi Location, and Multi Workstation Accounts?
**3PL (Third-Party Logistics)** accounts are tailored for scenarios with one shipping location handling multiple brands. They share the same courier details but might have several e-commerce integrations. 3PL accounts have access to all settings accept courier settings.
**Multi Location** accounts are suited for businesses with one online store shipping from various locations. Integrate your e-commerce store with the parent account and apply rules to direct orders to the correct shipping warehouse. These accounts cannot manage Integration settings, CSV file setup, Rules, Tracking & Notifications, Digital Signature, API, or Checkout Rates. Order writebacks will be processed via the parent account.
**Full Access** accounts provide complete control and are ideal when your operations don't fit solely into other account types. These accounts can manage courier and integration settings individually and their order writebacks are based on their own integration settings.
**Multi Workstation** accounts provide a separate linked login for another staff member or workstation while sharing the parent account's orders. Multiple printers alone do not require Multi Workstation accounts. Printing routes are configured in the Starshipit account, while physical printer mappings are configured in the Desktop App on each receiving computer. See [how Starshipit printing works](/articles/90200000000155-understand-how-starshipit-printing-works).
Can I cancel my child account?
To cancel a child account, navigate to **Settings** > **Child Accounts**, edit the desired account, and choose **Unlink user**. This will disassociate the child account by the next day. Afterwards, log in to the child account, select **Settings** > **Manage Account**, choose your plan, and click **Cancel** to complete the cancellation.
Can I unlink my child account so it becomes its own standalone account?
To convert a child account into a standalone Starshipit account, navigate to **Settings** > **Child Accounts**, edit the account you wish to unlink, and select **Unlink user**. Once the account is unlinked overnight, log in to the now-independent account. Then navigate to **Settings** > **Manage Account**, select the appropriate plan, and save the changes.
Can my child account access my main parent account?
Child accounts are restricted to access only within their account and cannot access the main parent account or any other accounts.
Can my main parent account access my child accounts?
The main parent account has the capability to access all associated child accounts using the parent account's login credentials.
Can you see reporting for your child accounts?
Starshipit reports can be executed for both parent and child accounts. Running a report from the parent account with "include child accounts" checked will compile data from all child accounts, indicating the specific account each data point pertains to. Reports run from a child account will only include data from that particular account.
If a customer purchases credit for SMS on the parent account, can the credit be used by child accounts to send SMS notifications?
SMS credits are not shared between the parent and child accounts. Each child account requires its own credit top-up to send SMS notifications.
Can a child account and a parent account have the same username?
Usernames within Starshipit must be unique; therefore, a child account cannot have the same username as its parent account or any other account.
Can I find orders from my child accounts from my parent account?
Orders placed within child accounts can be searched from the parent account. In the Workflows section, use the Search feature and ensure "Include Child accounts" is selected. The system will display orders across all accounts and indicate the specific child account for each order.
Can I print orders from my child accounts from my parent account?
You can print orders from child accounts directly from the parent account by going to Workflows > Scan and Print and ensuring "Include child accounts" is checked. Input the order number to locate and print the order without switching accounts. If duplicate order numbers exist, printing must be done from the specific child account.
---
# Choose a multi-location or 3PL setup
URL: https://support.starshipit.com/articles/90200000000405-choose-a-multi-location-or-3pl-setup
Canonical: https://support.starshipit.com/articles/90200000000405-choose-a-multi-location-or-3pl-setup
Markdown: https://support.starshipit.com/articles/90200000000405-choose-a-multi-location-or-3pl-setup.md
Updated: 2026-07-20
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Compare child accounts, Ship from store, Ops Manager, and WMS to choose the right setup for your operation.
Choose how to structure Starshipit when you operate across multiple locations, retail stores, brands, warehouses, or 3PL clients.
## Understand the options
These options solve different parts of a multi-location operation and can be used together.
| Option | Choose it when | What it adds |
| --- | --- | --- |
| **Linked accounts (child accounts)** | A location, brand, workstation, or 3PL client needs its own access or settings. | A parent account with linked child accounts. The account type controls which settings are separate or inherited. |
| **Ship from store** | You want retail stores to fulfil online orders using local inventory. | A fulfilment model that routes an order to the appropriate store and child account. Your commerce platform, OMS, or Starshipit rules can participate in routing. |
| **Ops Manager** | You need to monitor and manage multiple Starshipit accounts without switching between them individually. | Central visibility across locations and brands, including orders, exceptions, carriers, users, rules, billing, and supported routing or inventory features. |
| **Starshipit WMS** | You need to control stock and physical warehouse operations, not only shipping. | Inventory, warehouse locations, receiving, putaway, picking, packing, replenishment, stocktakes, and stock movements connected to Starshipit Shipping. |
## Choose a common setup
### Multiple warehouses or dispatch locations
Start with a child account for each location that needs separate pickup addresses, couriers, printers, integrations, or other settings. Add Ops Manager when the central team needs one operational view across those accounts.
Add Starshipit WMS when you also need location-level inventory control and guided warehouse workflows.
### Third-party logistics
Use a 3PL child account for each client that needs separate settings. Add Ops Manager when you need central monitoring, configuration, exception management, or billing across the client accounts.
### Ship from retail stores
Use Ship from store when online orders should be fulfilled by retail locations. Stores are generally represented by child accounts, while your commerce platform, OMS, or rules determine which store receives an order.
Add Ops Manager when head office needs central visibility and control across the store network.
### One warehouse that needs inventory control
Use Starshipit WMS when the main requirement is tracking where stock is stored and controlling receiving, picking, packing, replenishment, and stock movements. You do not need child accounts solely to use WMS.
## Set up your chosen model
1. [Choose a child account structure](/articles/360000553016-choose-an-account-structure-for-multiple-locations-or-3pl-clients-child-accounts) if you need separate accounts.
2. [Set up a child account](/articles/360001575375-set-up-an-account-for-a-location-brand-or-3pl-client-child-accounts).
3. Follow the relevant operating guide:
- [Configure a 3PL workflow](/articles/115000180963-configure-starshipit-for-a-3pl-workflow)
- [Set up Ship from store](/articles/9000119980047-set-up-ship-from-store)
- [Learn what Ops Manager does](/articles/15100000000001-what-is-ops-manager)
- [Learn what Starshipit WMS does](/articles/14700000000001-what-is-starshipit-wms)
:::note
If more than one option matches your operation, that does not mean the features overlap unnecessarily. Child accounts define the account structure, while Ship from store, Ops Manager, and WMS add different operational capabilities around that structure.
:::
---
# Configure Starshipit for a 3PL workflow
URL: https://support.starshipit.com/articles/115000180963-configure-starshipit-for-a-3pl-workflow
Canonical: https://support.starshipit.com/articles/115000180963-configure-starshipit-for-a-3pl-workflow
Markdown: https://support.starshipit.com/articles/115000180963-configure-starshipit-for-a-3pl-workflow.md
Updated: 2026-05-06
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Configure Starshipit for a 3PL workflow with child accounts and multi-location fulfilment.
Configure a 3PL workflow by creating a linked account for each client that needs separate settings. Starshipit calls these linked sub-accounts **child accounts** in the app. Review [Starshipit add-ons](/articles/12080147770127-about-our-add-ons) for current account availability and pricing.
## How it works
* Child accounts are attached to your main Starshipit account.
* Your child account generally has different settings from your parent Starshipit account e.g different couriers, integrations, pickup address and more. You can configure these based on individual customer requirements.
* You can easily switch between your different child accounts.
## Set up 3PL child accounts
1. In your [Starshipit account](https://app2.starshipit.com/), go to **Settings >** **Child Accounts**.
2. Click **Add a new child account**.
3. Set a username and password for the account.
4. Under Type, select **3PL Client Account**.
5. Select whether or not to **Hide Courier Rates**.
6. Click **Save**.
7. Configure settings specific to each account:
* **Pickup Address:** Go to **Settings** *>* **Pickup Address** and set the address of your warehouse.
* **Couriers details:** Enter credentials for each courier service.
* **Printing Parameter**: You'll need to set up the printer of the new location.
## Overriding your child account
Using your parent account you can override and access your secondary child account.
**For example:** If you have a parent swimwear business and you also sell protein powder under a different brand, you'll use the override function from your swimwear account to access your protein powder child account.
1. Click the drop-down menu in the top right of the dashboard. Then select **Switch accounts**.
2. Click **Switch** next to the child account you'd like to override.
---
# Manage multi-location, multi-brand, and dropshipping accounts
URL: https://support.starshipit.com/articles/360001188356-manage-multi-location-multi-brand-and-dropshipping-accounts
Canonical: https://support.starshipit.com/articles/360001188356-manage-multi-location-multi-brand-and-dropshipping-accounts
Markdown: https://support.starshipit.com/articles/360001188356-manage-multi-location-multi-brand-and-dropshipping-accounts.md
Updated: 2026-05-06
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Manage child accounts for multi-location, multi-brand, and dropshipping operations.
Use linked Starshipit accounts to separate shipping settings across multiple locations, brands, or dropshipping operations. Starshipit calls these linked sub-accounts **child accounts** in the app.
## Multi-location
* Use a multi-location account when you ship from multiple business locations or on behalf of multiple businesses, and want to bill shipping costs to different courier accounts.
* Multi-location child accounts have different settings from the parent account, like different addresses, couriers, package sizes, print settings, and contacts.
* Multi-location child accounts can't create integrations or customise notification emails. Only the parent account can do this.
:::important
Branded tracking is supported for **3PL** and **Full access** child accounts. It is not available for Multi-location child accounts.
:::
For example, if you have multiple stores in various locations and you want to dispatch goods from a local store or warehouse to reduce overall shipping costs and efficiency, your workflow might look like this:
### How do courier integrations work with multi-location child accounts?
You can [assign orders to multi-location child accounts manually or by using a rule](/articles/115001657023). When you fulfil the order on the account, Starshipit will write-back the tracking number through the parent account's integration.
For example, if you [use the same Australia Post account](/articles/couriers/australia-post/using-one-australia-post-eparcel-account-id-in-multiple-starshipit-accounts) or account which uses increment numbers to create tracking numbers, you'll need to change the increment value on each account that you add a courier on.
#### How to set up increment numbers for multiple child accounts
We recommend separating the current increment value by at least 1,000,000 for each child account you have. For example, if your main account is set to 1,000,000, the next child account should be 2 million and then the next child account should be 3 million and so forth.
This is to avoid duplicate tracking numbers due to the same courier details being used in multiple accounts.
Please note that the increment value cannot exceed 7 digits.
### Set up a multi-location child account
1. In your Starshipit account, go to **Settings** > **Child Accounts**.
2. Click **Add a new child account**.
3. Under **Type**, select **Multi-location Account**.
4. Set a username and password for the account.
5. Select whether or not to **Hide Courier Rates**.
6. Click **Save**.
You can configure settings specific to each location:
* Pickup Address: Go to **Settings** > **Pickup Address**.
* Courier details: For most couriers (e.g. Australia Post), you'll need to get new API credentials. For some couriers, you can use the same credentials and copy and paste the information in **Settings** > **Couriers**.
* Printing Parameter: Set up the printer of the new location.
:::note
You should now have separate login credentials for each account: one for your main location and another for your new shipping location.
:::
## Multi-brand
If you dispatch multiple brands from the same warehouse, you can use your main parent account to create child accounts for each brand or business. Each child account will have its own manifest settings and customised branded notifications:
## Dropshipping
If the products you sell are held by a third-party, usually a wholesaler or manufacturer who ships your products directly to the customer, you can use your main parent account to create child accounts for each third-party. Configure business rules to automatically allocate orders across the child accounts. Each third-party will then fulfil orders within their respective child account:
---
# Allocate an order to another account (child account)
URL: https://support.starshipit.com/articles/115001657023-allocate-an-order-to-another-account-child-account
Canonical: https://support.starshipit.com/articles/115001657023-allocate-an-order-to-another-account-child-account
Markdown: https://support.starshipit.com/articles/115001657023-allocate-an-order-to-another-account-child-account.md
Updated: 2026-05-07
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Manually allocate orders to a linked account or automate allocation with shipping rules.
Allocate an order to another linked Starshipit account manually or with a shipping rule. Starshipit calls linked sub-accounts **child accounts** in the app.
## 1. Manually allocate an order to a child account
1. Go to your **Orders** page.
2. Right-click the order(s) you want to reassign, then click **Assign** to another account.
3. Select the child account from the list.
* NB: This will only be possible if you have set up a child account.
* NB: You can reassign orders back to your parent account from the child account using the manual method, but you can't reassign orders from one child account to another.
* NB: This can only be done with orders in the **New** tab.
## 2. Create a rule to allocate an order to a child account
1. Go to **Settings** > **Rules** > **Add a new rule**.
2. Select **Destination postcode.**
3. Enter your list of postcodes.
4. Select **Assign to Another Account.**
5. Select the account name.
## Troubleshooting
### Why do orders keep re-importing into the parent account after I manually assign them?
Manual assignment does not change your integration import logic. If auto-import and webhooks are still enabled on the parent account, the same order can be imported again.
To avoid this, use one approach consistently:
* **Manual workflow:** manually import and manually assign orders (with auto-import/webhooks disabled where required).
* **Automated workflow:** use **Assign to Another Account** rules with auto-import/webhooks enabled.
Avoid mixing both workflows for the same order stream.
---
# Set up ship from store
URL: https://support.starshipit.com/articles/9000119980047-set-up-ship-from-store
Canonical: https://support.starshipit.com/articles/9000119980047-set-up-ship-from-store
Markdown: https://support.starshipit.com/articles/9000119980047-set-up-ship-from-store.md
Updated: 2026-05-06
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Learn how to set up ship from store with Starshipit, including order routing, child accounts, and delivery options.
This guide covers how to implement a ship from store strategy using Starshipit, including the platforms and integrations you'll need.
**Ready to get started?** [Book a free consultation with our shipping experts](https://starshipit.com/book-a-ship-form-store-consultation).
{{video:youtube:AadcmxhIgr0}}
## What is ship from store?
Ship from store is a shipping approach where you use your brick-and-mortar inventory to meet orders originating from your online sales platforms, such as Shopify or BigCommerce.
Basically, when a customer makes a purchase through an online store, the order is routed to a physical store for fulfillment rather than being processed at a centralised warehouse. Ship from store aims to reduce order fulfillment times and, in some cases, lower transportation expenses. It can also help to reduce deadstock by improving inventory turnover.
## Why ship from store?
When implemented correctly, a ship from store strategy reduces delivery times by utilising local retail inventory for online orders. This strategy enhances customer satisfaction, minimises shipping costs, and optimises inventory management. Additionally, it leverages your brick-and-mortar stores as distribution hubs, streamlining your supply chain and ensuring efficient and timely order fulfillment.
To back this up, one study from Newstore found that 68% of customers reported convenient fulfillment options such as buying from one store, while collecting from another, were at the top of their list of buying considerations.
Here are some of the other benefits:
* **Keep freight costs down:** Shipping from store is a great way to combat rising freight costs if you have a network of stores, but don’t have multiple fulfilment centres.
* **Improve inventory turnover and reduce deadstock:** Fulfilling online orders using retail stock means higher inventory turnover (less ageing stock). It also helps you to avoid the issue of deadstock.
* **Increase delivery speed:** Ship from store is a great way to improve your delivery speed and achieve faster delivery timeframes (like same-day delivery)
* **Reduce cart abandonment:** Free shipping (and shorter shipping timeframes) can have a big impact on reducing cart abandonment. Using the ship from store model can help you to more easily meet these timeframes.
* **Reduce the impact of warehouse issues:** With your retail stores able to service online orders, any problems with your main warehouse become far less of a concern. For example, if you need to temporarily close the warehouse.
## How to get started with Ship from Store
If you decide to ship from store, you’ll have a few decisions to make, including how to structure your order routing, point of sale, delivery and post-purchase communications.
:::note
Every ship from store strategy will be different based on your business needs, so it's important to understand the different options available to you. In this section, we’ll broadly cover the key parts of a ship from store strategy that you’ll need to consider.
:::
**Platform-specific guides:**
- [stockinstore](/articles/9067429315215-configure-ship-from-store-with-stockinstore)
- [BigCommerce](/articles/9067499824783-configure-ship-from-store-with-bigcommerce)
- [Shopify](/articles/9391626045711-configure-ship-from-store-with-shopify)
- [Viare](/articles/10102314029199-configure-ship-from-store-with-viare)
## Order routing
Order routing is the process of determining the most efficient and cost-effective way to fulfill an online order by selecting a specific retail store as the fulfilment location. Most retailers will have a criteria matrix that prioritises one location over another. These criteria could include factors like:
* Which stores have stock?
* Lowest cost delivery
* Can the location fulfil the entire order?
* Prioritise stores with higher stock levels
How you route orders will depend on factors like which platforms you’re currently using, whether that’s your OMS or a dedicated solution.
* You can view a full list of the all the platforms (and carriers) that Starshipit integrates with [here on our integrations page](https://starshipit.com/integrations). For other platforms, you may want to [check out our Developer Center](/developers).
If you’re just using Starshipit to handle order routing, you’re limited by the conditions the Starshipit rules engine includes (like destination post code). You’ll need an OMS or other platform to route based on the conditions we’ve outlined above.
## Delivery options
You can offer many different shipping options to your customers, including standard, express, same-day and more.
This is important, as customers are increasingly demanding more choice when it comes to shipping, and faster delivery timeframes. In fact, one report from McKinsey shows that over 90% of US online customers expect free shipping within a couple of days.
Many carriers now offer on-demand shipping, enabling customers to receive their orders well within the same day they place an order.
On demand delivery providers include:
* Sherpa
* Rendr
* Uber Direct
* Zoom2u
* Startrack
* DHL Express
* Australia Post
Check out our full list of carriers [on our integrations page](https://starshipit.com/integrations).
## Point of sale
Businesses must carefully choose POS systems that facilitate quick and reliable transactions. Just as customers expect prompt online order fulfillment, they also anticipate swift and seamless experiences at physical points of sale, emphasising the importance of choosing POS systems that align with evolving consumer preferences.
You may want to use your existing POS for your store staff to fulfil from, or Starshipit – more on this to below.
Point of sale systems include:
* Shopify POS
* Retail Express
* Microsoft Nav vison
* Lightspeed
* Square
## Post-purchase
Finally, customers expect to be kept in the loop after they’ve placed an order. With the appropriate permissions, send text and email notifications for every stage of the delivery journey. This means once you’ve confirmed their order, when the tracking number is allocated, key delivery milestones and when it arrives.
Some retailers prefer to use SMS notifications for ship from store orders given the shorter delivery time frames. For example, you could trigger an SMS notification whenever a label gets printed to ensure the notification reaches the customer as soon as possible.
* [Learn about notifications in Starshipit](/articles/notifications-branded-tracking-rules-child-accounts/notifications/about-notifications-and-branded-tracking)
## Ship from store with Starshipit
Starshipit serves as the smart, automated link between your online store, physical stores, and carriers.
**How it works:**
1. Customers place orders online through your eCommerce platform
2. Orders get allocated to a retail store (via your OMS or routing rules)
3. The fulfilment location is communicated to Starshipit and routed to the correct child account
4. Store staff access the Starshipit dashboard to pick, pack and print labels
5. Starshipit updates your source system with tracking data and order status
**For head office and customer service:**
- Search from your master account to see which store has been assigned to fulfil any order
- Answer customer queries like "where's my order?" without switching accounts
- Use rules to assign orders to store accounts (based on post code, for example)
## Child accounts
[Child accounts](/articles/360000553016) are attached to your parent Starshipit account. Your child account generally has different settings from your parent Starshipit account e.g. different couriers, integrations, pickup address and more.
There are different types of child accounts:
* **Multi-location:** Use this when you are shipping from two or more physical locations. For multi-location child accounts, customer notifications, branding and integrations are inherited from your parent account.
* **Full access:** Use a full access child account if you want different notification settings for each store
Note: You can adjust carrier accounts, print settings and sender addresses for each child account.
## Learn more – Case studies
### Toyworld
Toyworld is Australia’s largest specialist toy retailer with 125 stores across the country. On a mission to optimise fulfilment, Toyworld implemented Find in Store in 2020, click & collect in 2021 and lastly ship from store/store fulfilment. Toyworld used Starshipit and stockinstore to complete this omnichannel transformation.
Since implementing Starshipit and stockinstore, Toyworld has achieved:
* 118% increase in online conversion rates.
* 198% increase in click & collect sales in 2022 vs 2021.
Read the full case on the Starshipit blog:
* [Read the full case study](https://starshipit.com/blog-content/omnichannel-fulfilment-strategy-toyworld-stockinstore)
### Lorna Jane
Aussie fashion giant Lorna Jane are leaders when it comes to meeting customer expectations. With delivery speed and stock turnover in mind they found great success with ship from store by “igniting the stock pool” and linking up all stores under one eCommerce platform. Lorna Jane has simplified the process of shipping orders to customers.
Read the full case on the Starshipit blog:
* [Read the full case study](https://starshipit.com/case-study/lorna-jane)
## Book a free ship from store consultation with Starshipit
In this call, we'll cover how you can set up ship from store with Starshipit as well as your existing tech stack. We'll also work with you based on your own goals and requirements.
* [Book a consultation here](https://starshipit.com/book-a-ship-form-store-consultation)
---
# Configure ship from store with Shopify
URL: https://support.starshipit.com/articles/9391626045711-configure-ship-from-store-with-shopify
Canonical: https://support.starshipit.com/articles/9391626045711-configure-ship-from-store-with-shopify
Markdown: https://support.starshipit.com/articles/9391626045711-configure-ship-from-store-with-shopify.md
Updated: 2026-05-06
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Set up ship from store using Shopify locations, order routing, and Starshipit child accounts.
This guide covers how to set up ship from store using Shopify's fulfilment locations and order routing, integrated with Starshipit child accounts.
For a general introduction, see [Set up ship from store](/articles/9000119980047-set-up-ship-from-store).
## How it works
Setting up a ship from store workflow with Starshipit and Shopify is simple and requires that you set up fulfilment locations and order routing in Shopify and the associated child accounts in Starshipit.
## Set up fulfilment locations in Shopify
To start, set up your fulfilment [locations](https://help.shopify.com/en/manual/locations?_gl=1*1v6sdjz*_gcl_au*NTA3ODc5NTc0LjE3MDA0MjQ5MzM.&_ga=2.150270709.299258673.1705883239-1892682337.1691528791) in Shopify, one for each store location you want to be able to fulfil online orders from.
You can read the Shopify guide [here](https://help.shopify.com/en/manual/locations/setting-up-your-locations).
:::note
A location in Shopify is any physical place or app where you do any or all of the following:
- Sell products
- Ship or fulfill orders
- Stock inventory
:::
## Set up order routing rules in Shopify
Order routing automatically routes orders to fulfilment locations based on a set of routing rules. You can use the default settings in Shopify or adjust your order routing based on your requirements.
You can access order routing in Shopify after you set up two or more active locations. Order routing uses rules to determine the locations to use to fulfil each item in a customer’s order. By adjusting rules, you can determine how locations are prioritized.
You can read the Shopify guide [here](https://help.shopify.com/en/manual/shipping/setting-up-and-managing-your-shipping/order-routing).
## Set up child accounts in Starshipit
Child accounts are attached to your parent Starshipit account. Your child account generally has different settings from your parent Starshipit account e.g. different couriers, integrations, pickup addresses and more.
1. Set up the same locations you’ve created in Shopify as Multi-Location child accounts in Starshipit.
2. Integrate your Shopify account to each Starshipit child account (using the Shopify Enhanced integration in Starshipit).
1. In the integration settings, select which fulfilment locations in Shopify you would like to import into this account.
2. Do this for each child account, matching the correct fulfilment location to the appropriate child account.
You can read more about child accounts [here](/articles/360000553016).
## Ship from store workflow
Once configured, orders are automatically assigned to locations in Shopify and come through to the correct Starshipit child account for fulfilment.
Your store staff can access their appropriate Starshipit child account directly to pick, pack and print labels. Or, you can use our open API to print labels via Starshipit using your point of sale (POS) system.
---
# Configure ship from store with BigCommerce
URL: https://support.starshipit.com/articles/9067499824783-configure-ship-from-store-with-bigcommerce
Canonical: https://support.starshipit.com/articles/9067499824783-configure-ship-from-store-with-bigcommerce
Markdown: https://support.starshipit.com/articles/9067499824783-configure-ship-from-store-with-bigcommerce.md
Updated: 2026-02-02
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Learn how BigCommerce integrates with Starshipit for ship from store fulfilment.
This guide covers how BigCommerce integrates with Starshipit to enable ship from store fulfilment directly from your retail locations.
For a general introduction, see [Set up ship from store](/articles/9000119980047-set-up-ship-from-store).
## About ship from store with BigCommerce
BigCommerce's integration with Starshipit streamlines the ship from store model by:
- **Automating the shipping process** - Orders flow seamlessly from store to carrier
- **Offering real-time shipping rates** - Customers see accurate delivery options at checkout
- **Providing label printing** - Print labels directly within the BigCommerce platform
With Starshipit, businesses can efficiently manage inventory across multiple stores, select the best carrier for each shipment, and enhance customer satisfaction with faster delivery times.
## Key benefits
| Benefit | Description |
|---------|-------------|
| **Optimised shipping** | Reduce costs with flexible shipping strategies |
| **Multi-store management** | Handle inventory across all your locations |
| **Carrier selection** | Choose the best carrier for each shipment |
| **Faster delivery** | Meet customer expectations with quicker fulfilment |
## About BigCommerce
BigCommerce is the premier Open SaaS and composable ecommerce platform that empowers brands and retailers of all sizes to build, innovate and grow their online businesses.
**Key facts:**
- Tens of thousands of B2C and B2B companies across 150 countries
- All retail sectors: fashion, food & beverage, health & beauty, sports, home & garden, and more
- Omnichannel selling: online stores, social media, digital marketplaces
- Thousands of technology and agency partners
## Integration with Starshipit
Starshipit is a BigCommerce preferred technology partner, available in the BigCommerce app marketplace.
**What you get:**
- Integration with all major global couriers (Australia Post, DHL Express, Sendle, TNT, Royal Mail, FedEx, and more)
- Five-star unlimited support
- Free onboarding
## Get started
To set up ship from store with BigCommerce and Starshipit:
1. Install Starshipit from the [BigCommerce app marketplace](https://www.bigcommerce.com/apps/starshipit/)
2. Configure your store locations as child accounts in Starshipit
3. Set up order routing rules to direct orders to the appropriate store
4. Connect your preferred carriers
For more details, see [Set up ship from store](/articles/9000119980047-set-up-ship-from-store).
---
# Configure ship from store with stockinstore
URL: https://support.starshipit.com/articles/9067429315215-configure-ship-from-store-with-stockinstore
Canonical: https://support.starshipit.com/articles/9067429315215-configure-ship-from-store-with-stockinstore
Markdown: https://support.starshipit.com/articles/9067429315215-configure-ship-from-store-with-stockinstore.md
Updated: 2026-02-02
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Learn how stockinstore's order management system integrates with Starshipit for ship from store fulfilment.
This guide covers how stockinstore's ship from store solution integrates with Starshipit to enable efficient order fulfilment from your retail locations.
For a general introduction, see [Set up ship from store](/articles/9000119980047-set-up-ship-from-store).
## About ship from store with stockinstore
stockinstore's ship from store solution helps retailers use their store network as a competitive advantage:
- **Ship more efficiently**: Fulfil orders from the most optimal store location
- **Reduce delivery times**: Get products to customers faster by shipping locally
- **Improve inventory management**: Better visibility and turnover across all locations
Together with Starshipit, stockinstore provides a seamless approach to omnichannel fulfilment.
## How it works
The stockinstore Order Management System (OMS) identifies the best store to fulfil each online order by assessing:
- **Inventory levels** - Which stores have the items in stock?
- **Proximity to customer** - Which store is closest for faster delivery?
- **Allocation rules** - Custom rules based on your business logic
Once a store is selected:
1. The order appears in the stockinstore OMS Portal
2. Store staff pick and pack the order
3. Shipping labels are generated and printed through Starshipit
4. The order is dispatched directly from the store
This reduces transit times and costs while improving customer satisfaction.
## Integration
stockinstore works with:
- All major eCommerce platforms
- POS and ERP systems
- Starshipit for shipping and tracking
The integration covers the entire fulfilment process - from order placement, to pick and pack, to label generation and shipment tracking.
## Scalability
The solution scales with your business:
| Business size | How it helps |
|---------------|--------------|
| **Small boutique** | Start with a few locations and simple rules |
| **Growing retailer** | Add locations and customise allocation logic as you expand |
| **Large chain** | Handle high volumes with real-time inventory visibility and automated routing |
## Success story: Toyworld Australia
Toyworld Australia, a Member/Franchise retailer with 125+ stores, used stockinstore and Starshipit to transform their omnichannel fulfilment:
**Results achieved:**
- Significant reduction in shipping times
- Improved order accuracy
- Online orders fulfilled from stores with the same efficiency as their distribution centre
- Higher customer satisfaction and increased sales
## Summary
Ship from store with stockinstore and Starshipit enables retailers to:
- Fulfil online orders from physical stores efficiently
- Optimise inventory across all locations
- Scale operations without sacrificing speed or accuracy
For more details, see [Set up ship from store](/articles/9000119980047-set-up-ship-from-store).
---
# Configure ship from store with Viare
URL: https://support.starshipit.com/articles/10102314029199-configure-ship-from-store-with-viare
Canonical: https://support.starshipit.com/articles/10102314029199-configure-ship-from-store-with-viare
Markdown: https://support.starshipit.com/articles/10102314029199-configure-ship-from-store-with-viare.md
Updated: 2026-05-06
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Learn how Viare's order management system integrates with Starshipit for intelligent ship from store routing.
This guide covers how Viare's order management system integrates with Starshipit for intelligent ship from store routing and fulfilment.
For a general introduction, see [Set up ship from store](/articles/9000119980047-set-up-ship-from-store).
## About Viare
Viare is an order management system powered by an intelligent routing engine. It helps retailers manage inventory across:
- Stores
- Distribution and fulfilment centres
- Dark stores and micro fulfilment centres
- Suppliers and 3PL providers
The Viare OMS determines and orchestrates how orders can be fulfilled based on real-time inventory availability, proximity to customer, and freight costs.
[Read Viare's Store Based Fulfilment Guide](https://20814341.fs1.hubspotusercontent-na1.net/hubfs/20814341/Documents/store-based-fulfilment.pdf)
## How it works
Viare's order management rule engine:
1. **Receives order data** from your eCommerce platform
2. **Checks inventory** across all fulfilment locations in real-time
3. **Calculates costs** including freight and fulfilment
4. **Routes the order** to the location that provides the best customer outcome at the lowest cost
Key features:
- **Demand-driven allocation** - Stock is allocated at the time of pick, not before
- **Pull-based logic** - Near real-time decision making
- **Click & Collect support** - Ship-to-home and ship-to-store made easy
## Integration
Viare integrates with:
| Platform type | Examples |
|---------------|----------|
| **eCommerce** | Magento, Shopify Plus |
| **Connection methods** | SOAP, REST, Webhook, Flat Files, Connectors |
| **Shipping** | Starshipit for label generation and tracking |
Gartner has recognised Viare as a sophisticated, smart order management system optimised for modern eCommerce operations.
## Scalability
Viare supports retailers of all sizes:
- **Scalable solutions** designed for your specific needs
- **Up to 40% increase in revenue** through better inventory visibility
- **Conversion rates as high as 300%** by never missing a sale
- **Reduced order cancellations** through accurate inventory management
## Success stories
### Briscoes Group (Rebel Sport and Briscoes)
> "The Group believes it has one of the best in-store online fulfilment systems in New Zealand. The system was improved during the half-year by the introduction of fulfilment routing and reporting enhancements, resulting in efficiency gains, lower freight costs and increased speed to customer."
>
> *Briscoes Group Interim Half Year Results*
### Paddy Pallin
> "From the moment of go-live, customers have experienced enhanced satisfaction with the seamless integration of Viare notifications, providing them with timely tracking details."
>
> *Online Technical Manager, Paddy Pallin*
Paddy Pallin achieved cost savings by minimising split orders and optimising courier options across their Australian store locations.
## Why Viare + Starshipit?
| Benefit | How it helps |
|---------|--------------|
| **Increased sales** | Store stock becomes available for online orders |
| **Lower freight costs** | Ship from the closest store to the customer |
| **Better load balancing** | Prevents any single location becoming a bottleneck |
| **100% pick accuracy** | Digital picking and pull-based routing |
{{video:youtube:e523iKRfihk}}
{{video:youtube:-puKj59X7Xc}}
---
# What is Ops Manager?
URL: https://support.starshipit.com/articles/15100000000001-what-is-ops-manager
Canonical: https://support.starshipit.com/articles/15100000000001-what-is-ops-manager
Markdown: https://support.starshipit.com/articles/15100000000001-what-is-ops-manager.md
Updated: 2026-05-04
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Get visibility and control across all your locations and brands from one central dashboard.
Ops Manager gives you a single place to oversee all your Starshipit accounts, without switching between them one by one.
## Who it's for
Ops Manager is built for businesses that run multiple fulfilment locations (warehouses, retail stores, or third-party logistics providers), each managed as a separate Starshipit account. If you're manually checking across accounts to catch issues or keep things moving, Ops Manager is designed for you.
## What's included
- **Dashboard overview**: see performance and operational health across all your locations and brands at a glance
- **Order monitoring**: catch exceptions, delays, and fulfilment issues before they become problems
- **Centralised management**: manage carriers, locations and brands, users, tags, and shipping rules from one place
- **Billing**: generate invoices across all child accounts without switching between them — see [Generating invoices with Billing](/articles/15100000000013-generating-invoices-with-billing)
- **Order routing**: assign pooled orders to specific stores and return them to the pool when needed (requires WMS add-on)
- **Inventory visibility**: view stock levels across all locations (requires WMS add-on)
- **Replenishment orders**: create replenishment orders based on Shopify sales data (requires Shopify integration)
## Pricing
Ops Manager is available as an early access add-on at **$10 per child account per month**.
Child accounts are the individual locations, brands, warehouses, or 3PL accounts you manage. Accounts with the following types count toward billing:
- **Full Access**
- **3PL**
- **Multi-location**
User-type accounts are not counted. They are used for access management only and are not billed as child accounts.
:::note
Pricing is subject to change as Ops Manager moves out of early access.
:::
## Accessing Ops Manager
Ops Manager runs as a separate dashboard alongside your main Starshipit account. You access it using your existing Starshipit credentials. There's no separate login or account needed.
---
# Get started with Ops Manager
URL: https://support.starshipit.com/articles/15100000000002-get-started-with-ops-manager
Canonical: https://support.starshipit.com/articles/15100000000002-get-started-with-ops-manager
Markdown: https://support.starshipit.com/articles/15100000000002-get-started-with-ops-manager.md
Updated: 2026-05-04
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Sign in to Ops Manager using your existing Starshipit account and learn how your locations, brands, and accounts are structured.
You access Ops Manager through your existing Starshipit account. No separate login needed. This guide covers sign-in, account structure, and how to confirm you're viewing the right account.
## How to sign in
Ops Manager uses your existing Starshipit credentials. If you're already signed in to Starshipit, you can open Ops Manager directly.
If you're not signed in yet, sign in to Starshipit first. Once you're signed in, Ops Manager is accessible from the dashboard link provided to you.
:::warning
Signing out of Starshipit also signs you out of Ops Manager. Sign back in to Starshipit to regain access.
:::
## Understanding your account structure
Ops Manager works across two levels of accounts.
**Your parent account** is your top-level Starshipit account. It owns or manages all the accounts beneath it, and it's the account you use to access Ops Manager.
**Child accounts** represent the individual locations and brands you manage, such as stores, warehouses, separate brands, or third-party logistics providers. There are three child account types that appear in Ops Manager:
- **Full Access**: a fully managed store or warehouse account
- **3PL**: a third-party logistics location
- **Multi-location**: a store or warehouse set up as part of a multi-location group
:::note
**User-type accounts** are for access management only. They do not appear in most views and are not counted as billable child accounts.
:::
## Checking your account details
The **Settings** page shows details about the account you're currently connected to. Use it to confirm you're viewing the right account, or to switch to a different one.
From **Settings**, you can see:
- Account name and ID
- Account type and plan
- Sender address
- Connected integrations
- Package templates
- Active Starshipit features
---
# Using the overview dashboard
URL: https://support.starshipit.com/articles/15100000000003-using-the-overview-dashboard
Canonical: https://support.starshipit.com/articles/15100000000003-using-the-overview-dashboard
Markdown: https://support.starshipit.com/articles/15100000000003-using-the-overview-dashboard.md
Updated: 2026-05-04
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Monitor order status, exceptions, and delivery performance across all your locations and brands from a single dashboard.
The overview dashboard is your landing screen after signing in. It gives you a live snapshot of order activity, exceptions, and delivery performance across all your locations and brands.
## Filters
Two filters sit at the top of the dashboard and apply across all tabs.
| Filter | Options |
|---|---|
| **Location & brand selector** | Defaults to **All locations & brands**. Use it to focus on a specific location or brand. |
| **Time period** | **Last 24 hours**, **Last 7 days**, **Last 30 days**, or **Last 90 days**. |
## Metric cards
Below the filters, four headline cards summarise your network at a glance:
| Card | What it shows |
|---|---|
| **Total Orders** | All orders in the selected period |
| **Unshipped Orders** | Orders that haven't been dispatched yet |
| **In Transit** | Orders currently moving through the carrier network |
| **Delivered** | Orders successfully delivered |
Clicking any card takes you to the Orders page, pre-filtered to match that status.
## Tabs
### Order status
Shows your order pipeline from **Unshipped** through to **Delivered**, plus an aged unshipped breakdown:
| Age window | Label |
|---|---|
| 24–48h | Within the usual ageing window |
| 48–72h | Needs attention |
| 72h+ | Critical delay |
Clicking a row opens the Orders page filtered to that location or brand, status, and age group.
### Exceptions
Lists active issues detected across your locations and brands. Each row shows:
- **Exception type**: Aged Unshipped, Transit Delay, Address Issues, or Manifest Delay
- **Location or brand** affected
- **Count** of matching orders
- **Severity** level
To investigate, click the external-link icon on the row. This opens the Orders page in a new tab with filters already applied.
When everything is running smoothly, the tab shows a **no exceptions** state. Check this tab regularly to catch issues before they reach customers.
For a full description of each exception type and the investigation workflow, see [Monitoring and acting on exceptions](/articles/15100000000012-monitoring-and-acting-on-exceptions).
### Performance
Shows three delivery metrics for the selected period:
- **Order-to-delivery business days**
- **Transit-time business days**
- **Delivery target breakdown** — progress bars showing how many orders landed in each window: Same Day, Next Day, 2–3 days, 4–5 days, and 5+ days
Use this tab to spot whether your network is meeting delivery commitments.
### Breakdown
Lists each location and brand with the following columns:
| Column | What it shows |
|---|---|
| **Total orders** | All orders for this location or brand |
| **Unshipped** | Orders not yet dispatched |
| **Printed** | Labels printed, not yet manifested |
| **In Transit** | Currently with the carrier |
| **Delivered** | Successfully delivered |
| **Fulfilment rate** | Percentage of orders reaching delivered status |
Click any column header to sort. Sorting by **Unshipped** visually highlights locations and brands with high counts.
## Numbers update as data loads
Figures load progressively as data comes in from each connected account. Numbers may shift briefly while the page loads — this is normal and not an error.
:::note
If the dashboard cannot display analytics, check that your account has eligible child accounts connected. Analytics will not load if no eligible locations or brands exist.
:::
---
# Managing locations and brands
URL: https://support.starshipit.com/articles/15100000000006-managing-locations-and-brands
Canonical: https://support.starshipit.com/articles/15100000000006-managing-locations-and-brands
Markdown: https://support.starshipit.com/articles/15100000000006-managing-locations-and-brands.md
Updated: 2026-05-04
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Add locations and brands, update pickup addresses, copy notification and package settings, and export data from the Locations & Brands page.
The **Locations & Brands** page is where you manage child accounts and the configuration shared across them. Use it to add locations and brands, keep addresses current, and push settings consistently across your network.
## Adding a location or brand manually
1. Go to **Locations & Brands**.
2. Select **Add account**.
3. Fill in the account details.
4. Review the default settings. All three are turned on by default:
- **Inherit address book**: the new account shares the parent's address book.
- **Clone carrier settings**: the new account starts with the same carrier configuration as the parent.
- **Apply all parent rules**: the parent's shipping rules are applied to the new account immediately.
5. Turn off any defaults you want to configure separately, then select **Create**.
## Bulk creating locations and brands from CSV
If you're adding many accounts at once, you can upload a CSV file instead.
1. Go to **Locations & Brands** and select **Bulk create**.
2. Download the example CSV to see the required column format.
3. Fill in your account details and save the file.
4. Upload the completed CSV and follow the prompts to finish the import.
## Updating pickup addresses
### Editing a single account's address
1. Find the account in the **Locations & Brands** table.
2. Select the account to open its details.
3. Edit the pickup address fields and save.
:::note
Pickup addresses load in the background per account. If one account's address fails to load, the others continue loading. You won't lose the rest of the list.
:::
### Bulk updating addresses from CSV
1. From **Locations & Brands**, select **Export with pickup addresses** to download the current address data.
2. Edit the exported file with your updated addresses.
3. Select **Bulk import pickup addresses** and upload the updated CSV.
## Copying notification settings
You can push notification settings from the parent account to child accounts in three ways:
- **Copy webhook notifications**: copies webhook URL and secret settings only.
- **Copy customer notifications**: copies customer-facing email and SMS template settings only.
- **Copy all notifications**: copies both webhook and customer notification settings at once.
For more granular control, open the notification dialog for an individual account. From there you can set the webhook URL and secret, and toggle email and SMS templates per shipment event.
## Copying package settings
Before you copy, you can review what the parent account has set up. The package summary shows the number of boxes configured, the number of satchels, and the import mode.
1. Open the package settings panel from **Locations & Brands**.
2. Review the parent's current package setup.
3. Select the child accounts you want to copy settings to.
4. Start the copy. Progress is tracked per account so you can see which accounts have been updated.
You can also view and copy package settings to a single account from that account's individual detail view.
## Exporting data
To download your list, select **Export** from the **Locations & Brands** page. The export includes the account details shown in the table.
To include pickup addresses in the export, use **Export with pickup addresses** instead.
---
# Managing users, rules, and configuration
URL: https://support.starshipit.com/articles/15100000000007-managing-users-rules-and-configuration
Canonical: https://support.starshipit.com/articles/15100000000007-managing-users-rules-and-configuration
Markdown: https://support.starshipit.com/articles/15100000000007-managing-users-rules-and-configuration.md
Updated: 2026-05-04
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Manage users, shipping rules, and tags across your account network. Invite users, copy rules, check rule parity, and sync tags in bulk.
This article covers the admin tasks for keeping your account network consistently configured: managing who has access, maintaining shipping rules, and keeping tags in sync across accounts.
## Users
The **Users** page shows all accounts of type **User**. These are access management accounts, not shipping locations.
### Inviting a new user
1. Go to **Users** and select **Invite user**.
2. Enter the user's email address.
3. Choose which accounts they can access.
4. Set their access controls.
5. Send the invitation.
### Bulk inviting or updating users
To invite or update many users at once, use the CSV options.
- **Bulk invite**: your CSV should include each user's email address, the account IDs they can access, and their access controls.
- **Bulk update**: use the same CSV format to update permissions and accessible accounts for existing users.
### Editing an existing user
1. Find the user in the **Users** table and select them.
2. Update their accessible accounts or access controls.
3. Save your changes.
### Other user actions
| Action | How |
|---|---|
| **Password reset** | Select a user and choose **Send password reset email** |
| **Delete user** | Select a user and choose **Delete** |
| **Export** | Select **Export** to download your full user list as a CSV |
## Shipping rules
Rules are loaded from both the parent account and all manageable child accounts. Rules with the same content are grouped into a single row. You see one entry per unique rule, not one entry per account. Each grouped rule shows which locations and brands have it, using coloured chips to make it easy to track the same account across the list.
### Finding rules
- **Filter by location or brand**: narrow the list to rules belonging to a specific account.
- **Search**: search by store name or by content within the rule.
- Sort and resize columns to suit your view.
### Copying and removing rules
| Action | How |
|---|---|
| **Copy a rule** | Select a grouped rule, then choose which accounts to copy it to |
| **Remove a rule** | Select a grouped rule, then choose which accounts to remove it from |
| **Replicate all parent rules** | Pushes all parent account rules to all child accounts at once |
### Rule parity
Rule parity compares each child account against the parent as a baseline. Use it to find accounts that have drifted out of sync.
| Status | What it means |
|---|---|
| Matched | The child account's rules match the parent. |
| Needs apply | Rules from the parent are missing from the child and can be applied. |
| Needs review | There are differences that require manual review before applying. |
| Load failed | The account's rules could not be loaded. |
When you open the parity detail for an account, you'll see a breakdown of:
- **Missing from child**: rules on the parent that aren't on the child yet.
- **Extra on child**: rules on the child that don't exist on the parent.
- **Blocked**: rules that reference a tag that doesn't exist in the child account, or where the tag match is ambiguous. This is the most common reason rule copies fail.
### Fixing a blocked rule
Tags have different internal IDs in each account, even when they share the same name. When a shipping rule references a tag by ID and that tag ID doesn't exist in the child account, the rule is blocked.
To fix it:
1. Go to the **Tags** section.
2. Find the tag the blocked rule uses. If the tag is missing from the child account, it will appear in fewer accounts than expected — look at the account chips on that tag row.
3. Select **Sync** on that tag and choose the child accounts where it's missing.
4. Once the tag exists in the child account, go back to **Shipping Rules** and retry the rule copy.
If the tag name is the same but the rule is still blocked, the child account may have multiple tags that could match. Resolve the ambiguity by removing duplicate tags from the child account before retrying.
## Tags
Tags are loaded from the parent and all eligible child accounts. Tags with the same name are grouped together, so you see one row per unique tag name rather than one row per account. Each tag row shows which accounts already have that tag.
### Creating a tag across accounts
1. Go to **Tags** and select **Create tag**.
2. Enter a tag name.
3. Choose the accounts you want to create it in.
4. Confirm. The tag is created in all selected accounts at once.
### Syncing a tag to accounts where it's missing
If a tag exists in some accounts but not others:
1. Find the tag in the list and select **Sync**.
2. Choose the accounts where the tag is missing.
3. Confirm. The tag is added to those accounts.
Any accounts that fail during the sync are listed separately so you can retry them.
## Ship-from-Store Rules
The **Ship-from-Store Rules** page shows SFS rules across your parent account and child accounts. For each rule it displays the conditions, the target account, and which locations and brands have equivalent rules.
This page is for reviewing your SFS rule coverage, not for editing rules. You can see at a glance whether the same SFS logic is consistently applied across your network, but you cannot create, copy, or delete rules here.
:::note
To create or modify Ship-from-Store rules, go to the individual account in Starshipit and edit its rules directly. Changes made there will be reflected here on the next load.
:::
---
# Managing carriers
URL: https://support.starshipit.com/articles/15100000000014-managing-carriers
Canonical: https://support.starshipit.com/articles/15100000000014-managing-carriers
Markdown: https://support.starshipit.com/articles/15100000000014-managing-carriers.md
Updated: 2026-05-05
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> View carrier status, edit carrier settings, and manage carrier configuration for child accounts from the Carriers page in Ops Manager.
The **Carriers** page shows your available carriers and lets you edit their settings. You can also manage carrier configuration for child accounts without switching between accounts.
## Carrier states
Each carrier in the list has a state that tells you its current status:
| State | What it means |
|---|---|
| **Added** | The carrier is configured and active on this account. |
| **Available** | The carrier is supported but not yet configured. |
| **Error** | The carrier is added but has a configuration issue. |
If a carrier shows **Error**, open its settings to review what's missing or invalid.
## Editing carrier settings
Each carrier is configured individually. There is no bulk "apply settings to all carriers" workflow.
1. Find the carrier in the list.
2. Select it to open the configuration dialog.
3. Update the settings and save.
If the save fails, the issue is typically a validation problem or an upstream API error. Check that all required fields are filled in correctly and try again.
## Managing carrier settings for child accounts
From the Carriers page you can also view and edit carrier configuration for your child accounts without leaving the parent view.
1. Find the carrier you want to manage.
2. Open the child-account carrier management dialog for that carrier.
3. Select the child account you want to configure.
4. Update the settings and save.
This is useful when you need to apply a consistent carrier configuration across multiple locations without opening each account separately.
---
# Routing orders across locations
URL: https://support.starshipit.com/articles/15100000000005-routing-orders-across-locations
Canonical: https://support.starshipit.com/articles/15100000000005-routing-orders-across-locations
Markdown: https://support.starshipit.com/articles/15100000000005-routing-orders-across-locations.md
Updated: 2026-05-04
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Assign pooled orders to fulfilment locations manually or automatically, and configure routing settings to control how orders are distributed.
Order routing lets a parent account distribute incoming orders across multiple fulfilment locations. Unassigned orders sit in a shared pool until you route them, either manually or automatically.
:::warning
Order routing requires the WMS add-on. If you don't see the **Order Routing** section, contact your account manager to confirm the add-on is enabled.
:::
## Assigning a pooled order manually
Pooled orders haven't been sent to a location yet. You can assign them one at a time or in bulk.
1. Go to **Order Routing** and open the **Pooled** tab.
2. Find the order you want to assign. Use the search bar to filter by order reference or recipient.
3. Review the recommendation text on the order row. This shows which location or brand the system suggests, but you can choose any location.
4. Select a location or brand from the assignment list and confirm.
The order moves to the **Assigned** tab and receives a routing tag.
## Bulk assigning orders
1. Go to **Order Routing** and open the **Pooled** tab.
2. Select the checkbox next to each order you want to assign.
3. Choose **Bulk assign** and select a destination location or brand.
4. Confirm the action.
A summary displays after the bulk action completes. It shows which orders were assigned successfully and which were not. Review any failures and assign them individually if needed.
:::note
In a bulk action, each order is processed separately. Some may succeed while others fail. The summary after the action tells you exactly which orders were affected.
:::
## Returning an order to the pool
If an order has been assigned to the wrong location, you can return it to the pool and reassign it.
**To return a single order:**
1. Open the **Assigned** tab.
2. Find the order and select **Return to pool**.
**To return multiple orders:**
1. Open the **Assigned** tab.
2. Select the checkboxes next to the orders you want to return.
3. Choose **Bulk return to pool** and confirm.
The same partial-success behaviour applies to bulk returns. Check the summary to see which orders moved back to the pool.
## Manual routing vs auto routing
With **manual routing**, you choose which location or brand receives each order. The system shows a recommendation, but the decision is yours. Use this when you need full control. For example, if an order contains special items that only one location can fulfil.
With **auto routing**, the system assigns orders to locations and brands automatically based on your routing settings. You set the rules once, and the system applies them without intervention. Use this when you have clear routing logic and want to reduce manual work.
Both modes can run at the same time. Individual locations and brands can have auto-routing enabled or disabled, so some receive orders automatically while others require manual assignment.
## Configuring routing settings
Access routing settings by selecting **Settings** from the **Order Routing** page.
### Enable auto-routing globally
The **Enable auto-routing** toggle turns auto-routing on or off for your entire account. When this is off, no orders are routed automatically, regardless of per-store settings.
### Per-location and brand settings
Each location or brand in your routing pool has its own set of controls.
| Setting | What it does |
|---|---|
| **Priority** | Sets the order in which locations and brands are considered when routing. Lower numbers are considered first. |
| **Included** | Controls whether this location or brand is part of the routing pool at all. Excluded locations won't receive any orders. |
| **Auto-route** | Enables or disables automatic routing for this specific location or brand. A location can be included in the pool but still require manual assignment. |
| **Temporarily unavailable** | Marks a location or brand as not accepting orders right now. Use this during a stocktake or when a location has a capacity issue. Orders won't be routed to it until you remove this flag. |
:::note
The routing settings page shows where your current settings are saved from, either the WMS or a temporary local source. If your settings don't appear to persist between sessions, check this indicator. Settings saved locally may not carry over.
:::
---
# Viewing and filtering orders across locations and brands
URL: https://support.starshipit.com/articles/15100000000004-viewing-and-filtering-orders-across-locations-and-brands
Canonical: https://support.starshipit.com/articles/15100000000004-viewing-and-filtering-orders-across-locations-and-brands
Markdown: https://support.starshipit.com/articles/15100000000004-viewing-and-filtering-orders-across-locations-and-brands.md
Updated: 2026-05-04
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Browse and filter orders across all your connected locations and brands from one place, and open individual orders for full detail.
The Orders page lets you view and search orders across all your connected locations and brands without switching between accounts. You can narrow results using filters, share a filtered view with a colleague, or open any order to see its full detail.
## Available filters
Use the filters at the top of the page to focus on the orders that matter.
| Filter | What it does |
|---|---|
| **Status** | Filter by order state: unshipped, in transit, delivered, and more. Reflects the latest known state from shipment and event data. |
| **Location or brand** | Limit results to one or more specific locations or brands. |
| **Time period** | Choose a date range to match the window you want to review. |
| **Order age** | Filter by how long an order has been unshipped: **24–48h**, **48–72h**, or **72h+**. |
| **Exception type** | Show only orders with a specific type of exception. |
| **Search** | Free text search by order reference, recipient name, or other identifiable details. |
:::note
Dates display in the timezone set in your Starshipit **Settings**. If timestamps look off, check your timezone configuration first.
:::
## Saving and sharing filtered views
Every filter you apply is saved in the page URL automatically. You can bookmark a filtered view to return to it later, or copy the URL and share it with a colleague so they see exactly the same results.
When you click a metric card or an aged-order row in the overview dashboard, the Orders page opens with filters already set to match. You do not need to configure them manually.
## Opening an order
Click any row in the orders list to open the full detail view for that order. You'll see shipment information, tracking events, and any exceptions associated with the order.
## If orders seem to be missing
Check your active filters before assuming data is missing. A status filter, a store selection, or a narrow time period can all limit what appears in the list. Clear the filters one at a time to broaden the results.
:::warning
Results may take a moment to reflect the very latest data. If you need to confirm the current state of an order, refresh the page to load the most recent information.
:::
---
# Monitoring and acting on exceptions
URL: https://support.starshipit.com/articles/15100000000012-monitoring-and-acting-on-exceptions
Canonical: https://support.starshipit.com/articles/15100000000012-monitoring-and-acting-on-exceptions
Markdown: https://support.starshipit.com/articles/15100000000012-monitoring-and-acting-on-exceptions.md
Updated: 2026-05-05
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Understand the four exception types in Ops Manager, how severity is assigned, and how to follow up on affected orders.
Exceptions highlight orders that need attention before they become a problem for customers. Ops Manager checks for exceptions automatically across all your connected accounts and surfaces them in the **Overview** dashboard so you can act without digging through individual locations.
## Exception types
There are four exception types. An order can match more than one at the same time.
| Exception | Trigger condition | Severity |
|---|---|---|
| **Aged Unshipped** | Order is still unshipped and the order date is 2+ days old | Low / Medium / High (scales with count) |
| **Transit Delay** | Order has shipped but is still in transit 5+ days after the shipped date | Medium |
| **Address Issues** | Address validation result is Invalid or Failed | High |
| **Manifest Delay** | Label printed but manifest not sent, and the printed date is 1+ day old | Medium |
### Aged Unshipped
No label has been printed and no shipment has been created within the expected window. Severity scales with volume — a high count typically signals a fulfilment bottleneck or an account that has fallen behind.
### Transit Delay
This can indicate a carrier delay, a lost parcel, or a tracking event that has not updated.
### Address Issues
Shipping to an unvalidated address risks failed delivery, returned parcels, or carrier surcharges.
### Manifest Delay
This usually means an order is sitting in a pick-up queue that was not closed off at end of day.
## How severity works
Severity is set at the exception type level, not per individual order. Use it to guide prioritisation: **Address Issues** are always high priority; **Aged Unshipped** severity scales with volume; **Transit Delay** and **Manifest Delay** are always medium.
## Acting on an exception
The **Exceptions** tab shows a summary row for each active exception type. To investigate:
1. Go to **Overview** and open the **Exceptions** tab.
2. Find the exception type you want to investigate.
3. Click the external-link icon on that row. This opens the **Orders** page in a new tab with filters already applied: the exception type, the relevant location or brand, and the selected time period.
4. In the Orders list, review the affected orders.
5. Click any order row to open the detail view.
From the order detail view you can inspect:
- Address validation state
- Printed and shipped timestamps
- Carrier and tracking information
- Activity log and events timeline
:::note
There is no separate exception detail page. The order detail view surfaces the data that triggered the exception — address validation fields, manifest flags, printed and shipped dates, and tracking events — so everything you need to investigate is in one place.
:::
## Checking exceptions proactively
Check the **Exceptions** tab each time you sign in to Ops Manager, especially if you manage accounts with high order volume. The tab updates as data loads from each connected account, so a brief "checking for exceptions" state when the dashboard first opens is normal.
When no exceptions are present, the tab shows a clear confirmation. You do not need to click further to verify.
:::note
One order can match multiple exception types at the same time. For example, an order that is both unshipped after two days and has an invalid address will appear under both **Aged Unshipped** and **Address Issues**. Each exception type is counted and displayed independently.
:::
---
# Viewing inventory across locations
URL: https://support.starshipit.com/articles/15100000000008-viewing-inventory-across-locations
Canonical: https://support.starshipit.com/articles/15100000000008-viewing-inventory-across-locations
Markdown: https://support.starshipit.com/articles/15100000000008-viewing-inventory-across-locations.md
Updated: 2026-05-04
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> See a real-time summary of stock levels across all your connected child accounts from a single inventory page.
The Inventory page gives you a single view of stock across all your connected child accounts. Use it to check total unit counts, see which accounts are reachable, and search for specific SKUs.
:::warning
The Inventory page requires the WMS add-on on your parent account. If you see a "Requires WMS add-on" message, contact your account manager or check your current plan to enable access.
:::
## What the summary cards show
At the top of the page, four cards give you a quick snapshot of your inventory position:
| Card | What it shows |
|---|---|
| **Total SKUs** | Number of unique SKUs tracked across all child accounts |
| **Total units on hand** | Combined stock count across all accounts |
| **Connected accounts** | Child accounts successfully linked and returning data |
| **Unavailable accounts** | Child accounts that could not be reached during the last data load |
If one or more accounts show as unavailable, the rest of the page still loads with data from the accounts that did respond. You are not blocked from viewing inventory for the accounts that are reachable.
## Using the SKU table and search
Below the summary cards, the SKU table shows each unique SKU and whether it is present in each connected child account.
To find a specific SKU, type into the search field above the table. The table filters as you type. This is useful when you manage a large catalogue and need to check stock for a particular product quickly.
## Refreshing the data
Inventory data does not update automatically while you are on the page. To load the latest figures, select **Refresh**. This re-fetches data from all connected child accounts and updates both the summary cards and the SKU table.
:::note
If a child account is unavailable after a refresh, it will show as unavailable in the summary cards. This does not affect the data shown for other accounts.
:::
## This is a read-only view
The Inventory page is for visibility only. You cannot adjust stock quantities or make changes to inventory from this page. To update stock levels, go to the relevant child account directly.
---
# Creating replenishment orders
URL: https://support.starshipit.com/articles/15100000000009-creating-replenishment-orders
Canonical: https://support.starshipit.com/articles/15100000000009-creating-replenishment-orders
Markdown: https://support.starshipit.com/articles/15100000000009-creating-replenishment-orders.md
Updated: 2026-05-04
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Create replenishment orders based on Shopify location sales to restock products where they are needed.
The Replenishment page lets you generate restock orders based on what has sold at a Shopify location over a chosen period. It proposes quantities, lets you adjust them, and then creates the order.
:::warning
Replenishment requires a connected Shopify integration. If Shopify is not connected or is not returning data, you will not be able to proceed. Go to your integrations settings to connect Shopify before using this page.
:::
## Step 1: Load your Shopify locations
Select **Load locations** to pull in the list of locations from your connected Shopify store. Your available locations will appear once the load is complete.
## Step 2: Choose a location
Select the location you want to replenish from the list. This determines which location's sales data will be used to calculate replenishment quantities.
## Step 3: Choose a date range
Select a date range to define the sales period to base replenishment on.
| Option | Period |
|---|---|
| **Today** | Current day only |
| **Last 7 days** | Rolling 7-day window |
| **This week** | Current calendar week |
| **Custom** | Specify a start and end date |
## Step 4: Load sales data
Select **Load sales** to fetch sales data for the chosen location and date range. This populates the item list with quantities based on what sold in that period.
## Step 5: Review proposed quantities
The item list shows each product and the quantity proposed for replenishment. These figures are based directly on the sales volume for the period you selected.
Review the list before proceeding. If the quantities look correct, you can move on. If not, go to Step 6.
## Step 6: Adjust quantities if needed
You can edit any quantity in the list before creating the order. Select the quantity field for an item and enter the correct amount.
This step is optional. If the proposed quantities are accurate, you can skip straight to Step 7.
## Step 7: Enter or confirm the destination address
Enter the address where the replenishment order should be sent, or confirm the address if one is already populated. The address must be complete (including street, city, and postcode) before you can create the order.
:::warning
If the destination address is incomplete, the order cannot be created. Make sure all required address fields are filled in before continuing.
:::
## Step 8: Check for duplicate orders
Before creating the order, the system automatically checks whether a replenishment order already exists for this location and date range. If a duplicate is detected, you will see a prompt to confirm you want to proceed.
This is a normal part of the workflow, not an error. The check is there to help you avoid accidentally reordering stock for a period you have already actioned.
## Step 9: Create the replenishment order
Select **Create order** to submit the replenishment order. The order is created and you will see a confirmation.
## Running bulk replenishment across multiple locations
You can run replenishment across all your locations at once instead of doing them one at a time. Select **Bulk replenishment** and follow the same date range selection steps.
When bulk replenishment completes, the results are shown per location:
| Status | What it means |
|---|---|
| **Created** | Replenishment order was successfully created |
| **Skipped** | A recent replenishment order already exists for this location and period |
| **Error** | Something prevented the order from being created — review this location individually |
Skipped locations are expected and do not require any action. Error locations should be reviewed individually.
:::note
You can run replenishment for a skipped location manually using the single-location workflow if you need to override the skip.
:::
---
# Generating invoices with Billing
URL: https://support.starshipit.com/articles/15100000000013-generating-invoices-with-billing
Canonical: https://support.starshipit.com/articles/15100000000013-generating-invoices-with-billing
Markdown: https://support.starshipit.com/articles/15100000000013-generating-invoices-with-billing.md
Updated: 2026-05-05
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Use the Billing page to review usage across your child accounts, configure billing profiles, preview invoices, and generate them individually or in bulk.
The Billing page lets you review shipping usage across your child accounts and generate invoices for each client. You can configure billing profiles, set custom fees, preview invoices before sending, and track invoice status across your network.
## Selecting a billing period
When you open Billing, choose the period you want to work with using the billing period selector. Usage data is streamed from each connected account for that period. Figures load progressively, so you may see totals update briefly while data comes in.
:::note
If usage numbers look stale or don't match what you expect, the page may be showing cached data from a previous session. Refresh the page to load the latest figures.
:::
## Reviewing usage
Once data has loaded, the page shows usage across all eligible child accounts for the selected period. Use the account filter and search to narrow the list to specific clients.
Each row shows the usage figures that feed into the invoice estimate. Review these before generating invoices to confirm the data looks correct.
## Configuring billing settings
### Workspace billing profile
The workspace billing profile sets the default configuration used across all clients — your company name, contact details, and any standard fees or rates that apply broadly.
To update your workspace profile, go to the **Settings** section within Billing.
### Client billing profiles
You can override the workspace defaults for individual clients. Use client-level profiles to set custom fees, different rates, or other per-client billing configuration.
To edit a client profile, select the client from the list and update their billing settings.
## Previewing an invoice
Before generating an invoice, use the **Preview** option to see what the invoice will look like based on the current usage data and billing configuration. This lets you catch any issues with fees, rates, or account details before sending.
## Generating invoices
You can generate invoices one at a time or in bulk.
**To generate a single invoice:**
1. Find the client in the billing list.
2. Select **Generate invoice**.
3. Confirm the details and generate.
**To generate invoices in bulk:**
1. Select multiple clients using the checkboxes.
2. Choose **Generate invoices** from the bulk action menu.
3. Confirm and generate.
Generated invoices are stored and tracked with a status you update manually:
| Status | When to use it |
|---|---|
| **Generated** | Invoice has been created |
| **Sent** | Invoice has been sent to the client |
| **Paid** | Payment has been received |
## Exporting invoices
To export stored invoices, use the **Export** option. This downloads your invoice records for the selected clients and period.
---
# Set up Starshipit WMS
URL: https://support.starshipit.com/articles/14700000000002-set-up-starshipit-wms
Canonical: https://support.starshipit.com/articles/14700000000002-set-up-starshipit-wms
Markdown: https://support.starshipit.com/articles/14700000000002-set-up-starshipit-wms.md
Updated: 2026-09-15
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Step-by-step guide to enabling Starshipit WMS, signing in for the first time, and completing initial warehouse setup.
Connect Starshipit to WMS, prepare your product catalogue and locations, bring in opening stock, and verify one end-to-end order before going live.
{{video:youtube:-0gYjAKu-n8}}
## Before you start
Before enabling Starshipit WMS, make sure you have:
* An active Starshipit account.
* Admin (or equivalent) access to **Settings** in Starshipit.
* Products set up in Starshipit with SKUs (barcodes recommended for scanning workflows).
* If you use multiple Starshipit child accounts or warehouses, decide whether they should share a WMS instance. See [Choose one or multiple WMS instances](/articles/14700000000061-choose-one-or-multiple-wms-instances) before enabling the integration.
## Step 1: Add the Starshipit WMS integration
1. In Starshipit, go to **Settings > Integrations > Add a new integration**.
2. Under *Inventory, Warehouse or Retail Management Platform*, select **Starshipit WMS**.
## Step 2: Configure the integration options
When adding the integration, configure the following:
**Enable Sending Order Events to Starshipit WMS**
This must be ticked. It ensures orders and shipment events flow from Starshipit into WMS so the warehouse can allocate and fulfil them.
**Expand WMS bundle items into their components when printing shipments** *(optional)*
Enable this if you use exploding bundles and need component products to appear on shipping documents (for example, on customs declarations).
**Choose a WMS Override** *(optional)*
Use this if you want the current Starshipit account to share a WMS instance with a different Starshipit account. See [Choose one or multiple WMS instances](/articles/14700000000061-choose-one-or-multiple-wms-instances) for help choosing the right structure.
> **Example:** You have two child accounts — one for B2B and one for B2C — both shipping from the same warehouse. You can point both accounts to a single WMS instance using WMS Override.
## Step 3: Save and open WMS
1. Click **Save** to enable the integration.
2. Open [wms.starshipit.com](https://wms.starshipit.com) and sign in using your Starshipit credentials.
## Signing in
Sign in at [wms.starshipit.com](https://wms.starshipit.com) using your Starshipit username and password.
If you cannot sign in, confirm:
* The WMS integration is enabled in the correct Starshipit account.
* You are using the right account environment (for example, the correct child account).
## Initial setup steps
Once you can access WMS, open **Setup** and follow the core setup journey. It prepares the warehouse foundation first, then brings stock in and verifies fulfilment. Work through these steps before processing real orders:
### 1. Sync and review products
1. Go to **Products** in WMS.
2. Click the menu and choose a sync option to import products from your Starshipit account.
3. For each key product, review and set:
* Bundle configuration (exploding or require-stock)
* Tracking type (Standard, Batch, or Serial)
* Allocation strategy (FIFO, LIFO, FEFO, or LEFO)
* Unit-of-measure relationships (if you buy in cartons and sell in eaches)
Getting product configuration right early avoids receiving errors and allocation issues later. See [Products and inventory configuration](/articles/14700000000006-starshipit-wms-products-and-inventory-configuration) for details.
### 2. Set up warehouse locations
1. Go to **Locations** in WMS.
2. Create your core locations:
* **Pick faces** — forward-picking bins for fast order fulfilment.
* **Bulk storage** — reserve stock used to replenish pick faces.
* **Staging docks** — where inbound deliveries land before putaway.
* **Packing benches** — stations where orders are packed and shipped.
* **Special locations** — returns, quarantine, quality control, equipment/trolleys.
3. For pick faces, set minimum and maximum capacity if you plan to use automated replenishment.
See [Locations and warehouse setup](/articles/14700000000033-starshipit-wms-locations-and-warehouse-setup) for naming conventions, barcodes and layout options.
### 3. Seed your starting stock
If you are migrating from another system or setting up a fresh warehouse, import your current stock levels via the starting stock page:
You need `inventory.adjust`, synced products, and existing warehouse locations. Starting Stock adds positive whole-number opening balances for one location per SKU. It does not replace stock, and there is no user-facing undo. Use **Inventory > Stock Adjustments > Adjustments** for batch-, serial-, multi-location, or corrective changes.
1. Go to **Getting started > Bring stock in > Add starting stock**. After onboarding, use **Help > Setup Guide** to reopen the guide, or open [Starting Stock](https://wms.starshipit.com/dashboard/setup/starting-stock) directly.
2. Select **Have a lot of stock? Import via CSV instead**.
3. Select **Download a pre-filled template with your products**. WMS loads all product pages automatically.
4. Fill in `starting-stock-template.csv` with your opening quantities and locations. Keep its `sku,product_name,quantity,location` columns.
5. Import the completed file and review the staged quantities and locations.
6. Select **Save starting stock** once, then verify the balances in **Inventory**.
Follow [Migrate starting stock and cut over to Starshipit WMS](/articles/14700000000049-migrate-starting-stock-and-cut-over-to-starshipit-wms) for rehearsal, reconciliation, and error recovery.
### 4. Test an end-to-end order
1. Create a test order in your ecommerce platform or Starshipit.
2. Confirm it appears in WMS under **Orders**.
3. Release the order to create a pick job.
4. Pick, pack and ship the order, then verify:
* Inventory is reduced correctly in WMS.
* The order is marked as shipped in both Starshipit and WMS.
After the workflow is active, use the **Operations** dashboard to monitor work queues, warnings, stock health and fulfilment activity from one place.
## Installing the mobile app
Starshipit WMS has companion apps for handheld devices:
* **iOS** — in WMS, go to **System > Settings > Apps**, then select **Download for iOS** under Mobile Apps.
* **Android** — go to **System > Settings > Apps**, then select the Android download under Mobile Apps.
Mobile devices are automatically detected and redirected to a mobile-optimised experience when accessing WMS from a phone or tablet.
## FAQ
Do I need to set up WMS before processing orders?
You should complete at least products sync and location setup before processing real orders. Without locations, WMS cannot allocate stock to specific bins. Without correct product configuration, tracking and allocation rules will not behave as expected.
Can multiple Starshipit accounts share one WMS?
Yes. Use the **WMS Override** option in the integration settings to point multiple Starshipit child accounts to a single WMS instance when they share the same warehouse and inventory.
Can I keep using my current Starshipit workflows while setting up WMS?
Yes. WMS can run alongside your existing Starshipit pick/pack flows while you set up and test. See [Running WMS alongside Starshipit](/articles/14700000000004-running-wms-alongside-starshipit-hybrid-headless) for hybrid and headless models.
---
# Understand Starshipit WMS
URL: https://support.starshipit.com/articles/14700000000001-understand-starshipit-wms
Canonical: https://support.starshipit.com/articles/14700000000001-understand-starshipit-wms
Markdown: https://support.starshipit.com/articles/14700000000001-understand-starshipit-wms.md
Updated: 2026-08-06
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Learn what Starshipit WMS is, how it differs from a basic inventory system, and how it connects to Starshipit, commerce platforms, and warehouse tools.
**Starshipit WMS** is a warehouse management system designed to complement your existing Starshipit setup. It helps you track inventory, manage warehouse locations, and control how stock moves from inbound receiving through to outbound fulfilment.
Once enabled, Starshipit WMS connects directly to your Starshipit account. Orders, shipments and key events are kept in sync, so you can continue to use your existing Starshipit automations, rules and carrier integrations while the WMS manages what happens inside the warehouse.
You access the WMS at [wms.starshipit.com](https://wms.starshipit.com).
## What is the difference between an IMS and a WMS?
Many businesses start with an **Inventory Management System (IMS)**, which focuses on keeping stock figures accurate. An IMS answers: *"How much stock do I have?"*
A **Warehouse Management System (WMS)** goes further. It manages the physical operations of your warehouse — where stock is stored, how it moves, and how orders are picked, packed and shipped. A WMS answers: *"Where is my stock, and how should it move through the warehouse?"*
| | IMS | WMS |
|---|---|---|
| Tracks quantities (on hand, available, committed) | ✓ | ✓ |
| Tracks stock by warehouse location | | ✓ |
| Manages purchase orders and inbound receiving | | ✓ |
| Guided picking and packing workflows | | ✓ |
| Replenishment from bulk to pick-face | | ✓ |
| Batch, serial and expiry tracking | | ✓ |
| Stocktakes and cycle counts | | ✓ |
| Full stock movement audit trail | | ✓ |
**Starshipit WMS is a full WMS with integrated inventory management.** It combines stock-level visibility with physical warehouse workflows — all tightly linked to your existing Starshipit account.
## How Starshipit WMS connects to Starshipit
Once you enable the WMS integration in Starshipit:
* **Starshipit** remains the system of record for orders, shipments, carrier configuration and label printing.
* **Starshipit WMS** becomes the system of record for inventory, warehouse locations, putaway, picking, packing and stock movements.
Key events flow between the two systems automatically:
* When an order is created or updated in Starshipit, it appears in WMS for allocation and fulfilment.
* When an order is shipped in Starshipit, WMS finalises stock movements and marks the order as shipped.
* When stock is received, adjusted, picked, packed, or counted in WMS, inventory levels are kept accurate and can be written back to connected commerce platforms.
## What Starshipit WMS includes
Starshipit WMS covers the full warehouse lifecycle:
* **Warehouse setup** — flexible location structures with barcodes, capacity rules, and multi-zone support.
* **Products** — centralised catalogue with bundle, kit, batch, serial, client, barcode, and unit-of-measure support.
* **Inbound** — supplier and purchase order management, mobile receiving, staged putaway, draft receipts, and configurable over-receiving.
* **Outbound** — order allocation, routing, holds, single and batch picking, packing benches, label generation, and dedicated ship workflows.
* **Inventory management** — real-time stock dashboard, stocktakes, count-as-you-go counts, cycle counts, adjustments, replenishment, and inventory freeze controls.
* **Returns** — quarantine and returns locations, restocking workflows, write-offs.
* **Reporting** — fulfilment performance, SLA tracking, inbound receipts, staff productivity, restocking forecasts, expiring stock, and operational exceptions.
* **Mobile app** — handheld execution for picking, single-order packing and device label printing, receiving, putaway, kitting and cycle counts, with Starshipit sign-in and paired WMS worker access.
* **Integrations and automation** — inventory writeback, process logs, notifications, and webhooks for stock, job, and lifecycle events.
## Who is Starshipit WMS for?
Starshipit WMS is suited to businesses that:
* Ship from a physical warehouse and need to track exactly where stock is.
* Receive stock from suppliers and want purchase order visibility.
* Run picking and packing workflows with multiple team members.
* Need batch, serial or expiry tracking for regulatory or operational reasons.
* Want inventory accuracy without a separate, disconnected IMS.
Starshipit WMS is **not required** to use Starshipit. If you handle fulfilment entirely within Starshipit's existing pick/pack tools and do not need location-level inventory control, you can continue to do so.
## Next steps
* [How to set up Starshipit WMS](/articles/14700000000002-how-to-set-up-starshipit-wms) — prerequisites and step-by-step enable guide.
* [Key concepts and glossary](/articles/14700000000003-wms-key-concepts-and-glossary) — explains stock statuses, location types, job types and other WMS terminology.
* [Running WMS alongside Starshipit](/articles/14700000000004-running-wms-alongside-starshipit-hybrid-headless) — hybrid and headless models for teams transitioning gradually.
---
# Prepare your warehouse for WMS go-live
URL: https://support.starshipit.com/articles/14700000000043-prepare-your-warehouse-for-wms-go-live
Canonical: https://support.starshipit.com/articles/14700000000043-prepare-your-warehouse-for-wms-go-live
Markdown: https://support.starshipit.com/articles/14700000000043-prepare-your-warehouse-for-wms-go-live.md
Updated: 2026-07-20
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Use this checklist to prepare locations, products, people, devices, and a safe first day of warehouse operations.
Use this checklist before your warehouse starts receiving or fulfilling live stock in WMS.
## Before you switch on live work
Confirm the following:
1. **Locations are ready.** Create and label your receiving, bulk, pick-face, quarantine and dispatch locations. [Set up warehouse locations and work areas](/articles/14700000000033-starshipit-wms-locations-and-warehouse-setup).
2. **Products are ready.** Check SKUs, barcodes, tracking requirements and units of measure. [Configure WMS products and inventory](/articles/14700000000006-starshipit-wms-products-and-inventory-configuration).
3. **Opening stock is accurate.** Import or count stock, then resolve any material variance before releasing orders.
4. **People have the right access.** Add each user and test the tasks their role needs. [Set up WMS users, roles and client access](/articles/14700000000036-wms-users-roles-permissions-client-access).
5. **Your operating model is agreed.** Confirm which system owns stock, products and order fulfilment. [Choose your WMS operating model](/articles/14700000000042-choose-your-wms-operating-model).
6. **Printing is ready.** [Choose the printing route](/articles/90200000000155-understand-how-starshipit-printing-works), configure the required printer or Desktop App, and confirm which device or workstation should receive labels.
7. **Your first workflows are tested.** Run one purchase order from receiving to putaway, and one order from allocation to shipment using test stock.
## Test before go-live
Choose a small set of representative orders and test the workflows you will use on day one:
* receive a purchase order;
* put stock away and replenish a pick face;
* pick, pack and ship an order, confirming the label reaches the expected printer at the correct size;
* process a return; and
* check the stock movement history and any sales-channel writeback.
Record who will own exception handling on the first day, including missing stock, unscannable products, printing issues and orders that cannot be allocated.
## Start live operations
Start with a controlled batch of work. Reconcile the first received and shipped orders against the source system before processing the full day’s volume. Use [WMS reporting and insights](/articles/14700000000021-reporting-and-insights) to monitor throughput and exceptions.
---
# Choose your WMS operating model
URL: https://support.starshipit.com/articles/14700000000042-choose-your-wms-operating-model
Canonical: https://support.starshipit.com/articles/14700000000042-choose-your-wms-operating-model
Markdown: https://support.starshipit.com/articles/14700000000042-choose-your-wms-operating-model.md
Updated: 2026-09-11
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Decide how Starshipit WMS will work with Starshipit, your sales channels, warehouse locations, and clients.
Before configuring WMS, decide which system owns each part of your operation. This helps you choose the right setup guides and avoid duplicate processes.
## Choose how WMS fits your operation
| Operating model | Use it when | Start here |
| --- | --- | --- |
| **One warehouse** | You receive, store, pick and ship stock from one warehouse. | [Set up Starshipit WMS](/articles/14700000000002-set-up-starshipit-wms) |
| **WMS alongside Starshipit** | Your team needs to keep some shipping work in Starshipit while WMS manages selected warehouse workflows. | [Run WMS alongside Starshipit](/articles/14700000000004-running-wms-alongside-starshipit-hybrid-outbound-headless-mode) |
| **Multiple warehouses or brands** | Stock or fulfilment is handled by more than one WMS account or warehouse. | [Choose one or multiple WMS instances](/articles/14700000000061-choose-one-or-multiple-wms-instances) |
| **3PL or shared warehouse** | You fulfil stock for several clients and need client-scoped access and inventory. | [Set up WMS for a 3PL](/articles/14700000000032-wms-for-3pls-suggested-setup-guide) |
| **Inventory sync to sales channels** | You need WMS stock levels sent to connected commerce platforms. | [Understand WMS integrations](/articles/14700000000044-understand-wms-integrations) |
## Confirm the system of record
In a standard WMS setup, **Starshipit** manages orders, carrier services, shipping rules and labels. **WMS** manages warehouse locations, inventory, receiving, picking, packing and stock movements.
If another inventory or warehouse system remains in use, agree which system owns stock quantities, product changes and fulfilment status before you enable synchronisation. Do not allow two systems to write the same stock field without a clear ownership rule.
## Next steps
1. [Set up Starshipit WMS](/articles/14700000000002-set-up-starshipit-wms).
2. [Prepare your warehouse for WMS go-live](/articles/14700000000043-prepare-your-warehouse-for-wms-go-live).
3. Configure the locations, products, users and integrations needed for your chosen model.
---
# Choose one or multiple WMS instances
URL: https://support.starshipit.com/articles/14700000000061-choose-one-or-multiple-wms-instances
Canonical: https://support.starshipit.com/articles/14700000000061-choose-one-or-multiple-wms-instances
Markdown: https://support.starshipit.com/articles/14700000000061-choose-one-or-multiple-wms-instances.md
Updated: 2026-09-11
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Decide when to share one Starshipit WMS instance, when to use separate instances, and how to configure the WMS instance override.
Use this guide to decide whether your operation should use one shared Starshipit WMS instance or separate WMS instances. It explains how instances relate to physical warehouses, how Starshipit accounts point to an instance, and what to verify before you enable the integration.
## The short answer
Choose one shared WMS instance when the accounts share warehouse processes and can scope each operation with WMS client records or account mappings. Choose separate WMS instances when the operations need complete workspace isolation or have product, inventory, order, user or configuration boundaries that cannot coexist in one instance.
For a 3PL, a shared instance can keep each client's products, inventory, orders and user access scoped through WMS client records while preserving one operator interface. See [Set up WMS for a 3PL](/articles/14700000000032-wms-for-3pls-suggested-setup-guide) for that model.
| Choose one shared WMS instance when | Choose separate WMS instances when |
| --- | --- |
| Several Starshipit child accounts share a stock pool, or a 3PL shares warehouse processes while each client's records remain scoped. | Operations require complete workspace isolation or separate operational ownership. |
| You want one operator interface, product catalogue and operational work queue. | Orders, products and warehouse work must not be visible across operations. |
| The accounts share warehouse processes and configuration. | Different operations use conflicting SKU definitions or settings. |
| A parent account or warehouse team can manage the shared WMS environment. | You need to hide shared configuration or enforce reporting, permissions, account-group or operational-ownership boundaries that client scoping cannot provide. |
:::important
A physical warehouse and a WMS instance are different things. Locations and zones describe the physical layout inside an instance. They do not create separate inventory or account boundaries.
:::
## How warehouses, accounts and instances fit together
A physical warehouse is the place where stock is stored and work is performed. A WMS instance is the logical Starshipit WMS environment that owns its products, inventory, orders, locations, users and warehouse settings.
Use **locations** and **zones** to describe areas within an instance, such as bulk storage, pick faces, packing benches or a separate site area. For a 3PL, use WMS client records and access assignments to scope client-owned records inside a shared instance. Use separate WMS instances when the operation needs a hard boundary that the shared instance cannot provide. The number of buildings, floors or zones does not by itself decide the number of instances.
```mermaid
flowchart TD
accTitle: Decide whether to share or separate WMS instances
A[Start with the operational boundary] --> B{Can one WMS instance support the shared work and required boundaries?}
B -->|Yes| C[Use one shared WMS instance]
C --> C1[Locations and zones model physical areas]
C --> C2[Use client records or account mappings to scope shared operations]
B -->|No| D[Use separate WMS instances]
D --> D1[Each instance owns its products, stock, orders and locations]
D --> D2[Keep account routing and writeback separate]
```
The following patterns are common:
| Operation | WMS structure | How to model it |
| --- | --- | --- |
| One warehouse and one stock pool | One WMS instance | Use the current Starshipit account's WMS instance and create locations and zones for the warehouse layout. |
| One warehouse with several brands or sales channels | One shared WMS instance | Enable WMS for each source account and point each one to the same host account with **WMS instance override**. |
| Multiple warehouses with independent operations and separate ownership | Separate WMS instances | Give each independent warehouse or account group its own WMS instance, locations, users and operational settings. |
| Multiple warehouses deliberately operated as one pooled stock and work environment | One shared WMS instance may be suitable | Confirm the order routing, location naming, permissions and inventory writeback before enablement. |
## How WMS instance override works
When an account uses **Use current account**, its WMS order and shipment events go to the WMS instance owned by that account.
When an account selects another linked account under **WMS instance override**, its events go to the selected account's WMS instance. This lets several Starshipit accounts use one WMS environment. The override changes the WMS destination; it does not merge the Starshipit accounts or remove the originating account from the order.
For a shared instance, repeat the configuration for every Starshipit account that sends orders to that instance. The account that hosts the WMS instance must be configured and ready first.
```mermaid
flowchart LR
accTitle: Starshipit accounts routing order events to WMS instances
A[Starshipit account A Warehouse A] -->|WMS enabled Use current account| W1[WMS instance A]
B[Starshipit account B Same stock pool] -->|WMS enabled Override to account A| W1
C[Starshipit account C Independent operation] -->|WMS enabled Use current account| W2[WMS instance C]
```
:::caution
Do not use zones to separate operations that need independent stock, orders or permissions. Zones organize physical locations within one WMS instance. For a 3PL, use WMS client records and client access assignments for client-scoped records. Choose separate WMS instances when you need a hard operational boundary.
:::
## Before you configure the integration
Make these decisions before you enable WMS:
1. List every Starshipit account that creates orders for the warehouse.
2. Decide which account will host each shared WMS instance.
3. Confirm whether stock, products, orders, warehouse users and reporting should be shared or separate.
4. If you use Shopify or another commerce platform with multiple locations, confirm that each source location maps to the intended Starshipit account and inventory writeback destination. See [Set up Shopify with Starshipit WMS](/articles/14700000000018-set-up-shopify-with-starshipit-wms) for Shopify-specific mapping.
5. Make sure you have administrator access to the Starshipit integration settings and the relevant WMS instance.
Only linked or related Starshipit accounts appear as choices in **WMS instance override**. If the account you need is not listed, check the account hierarchy and permissions before continuing.
## Configure the WMS instance in Starshipit
Configure the setting in each Starshipit account that sends orders to WMS. Leave the override on the current account for a separate instance. Select the same host account in every source account when they should share one instance.
1. In Starshipit, go to **Settings > Integrations**.
2. Select **Starshipit WMS**. If it is not connected, select **Add a new integration**, then choose **Starshipit WMS**.
3. Turn on **Enable sending order events to Starshipit WMS**.
4. Under **WMS instance override**, select one of these options:
- **Use current account** to use this account's WMS instance.
- A linked account to send events to that account's WMS instance.
5. Select **Save**.
1. Go to **Settings > Integrations > Add a new integration**.
2. Select **Starshipit WMS** under *Inventory, Warehouse or Retail Management Platform*.
3. Tick **Enable Sending Order Events ['Order Created', 'Order Shipped'] to the Starshipit WMS**.
4. Under **WMS Instance Override (Optional)**, select the linked account that owns the shared WMS instance. Leave it unselected to use the current account's WMS instance.
5. Select **Save**.
The **Expand bundle items when printing shipments** option is separate from instance selection. Only enable it when your WMS bundle configuration requires component items on shipping documents.
## Verify the setup
Test the routing before importing or fulfilling live orders:
1. Open WMS from the host account and confirm that its products, locations and stock belong to the expected warehouse operation.
2. Create one test order from each Starshipit source account.
3. Confirm that each order appears in the expected WMS instance and, for a shared instance, under the correct source account or client mapping.
4. Release and ship a test order, then confirm that the shipment returns to the correct Starshipit account. If inventory writeback is configured for the source commerce integration, also confirm that the inventory update reaches the intended commerce location.
5. Open the expected WMS instance, then check **System > Process Logs** if an event does not arrive or writeback fails.
## Troubleshooting
| Problem | What to check |
| --- | --- |
| The override account is not available | Confirm that the accounts are linked in Starshipit and that you have access to the relevant integration settings. |
| Orders appear in the wrong WMS instance | Check the WMS setting on the account that created the order. The override must be configured on every source account, not only on the host account. |
| Stock from separate operations is mixed together | Confirm that the source accounts do not point to the same WMS instance unless WMS client or account mappings scope the records correctly. Zones cannot separate account-scoped stock. Use separate instances when the operation requires a complete stock and workspace boundary. |
| A shared warehouse shows the wrong physical area | Review the WMS locations and zones, then confirm that order routing and commerce-location writeback match the physical warehouse layout. |
| A user can see more shared configuration than expected | Review WMS roles and client access. Use separate instances when the operation requires complete workspace isolation. |
## FAQ
Does one physical warehouse always need one WMS instance?
No. A physical warehouse can use one shared instance for a common stock pool or a shared 3PL workspace with client-scoped records. Use separate instances when different operations need complete workspace isolation that shared client and access boundaries cannot provide.
Do multiple physical warehouses always need separate WMS instances?
No. Multiple warehouses can share an instance when you intentionally want a pooled operational view or client-scoped records and have confirmed the location, routing and writeback design. Use separate instances when each warehouse requires its own workspace, users or operational settings.
Can multiple Starshipit accounts share one WMS instance?
Yes. Enable WMS for each account and set **WMS instance override** to the same linked host account. Confirm the source account or client mapping for each account before importing live orders.
Can zones replace separate WMS instances?
No. Zones group physical locations inside one WMS instance. They do not create independent inventory, order or account boundaries.
What should I do if I am setting up a 3PL warehouse?
Start with [Set up WMS for a 3PL](/articles/14700000000032-wms-for-3pls-suggested-setup-guide). It explains how shared WMS clients, source-account mappings and client access work alongside the instance decision.
## Related articles
- [Set up Starshipit WMS](/articles/14700000000002-set-up-starshipit-wms)
- [Set up warehouse locations and work areas](/articles/14700000000033-starshipit-wms-locations-and-warehouse-setup)
- [Understand WMS integrations](/articles/14700000000044-understand-wms-integrations)
- [Transfer stock between warehouses](/articles/14700000000040-inter-warehouse-transfers)
---
# Migrate starting stock and cut over to Starshipit WMS
URL: https://support.starshipit.com/articles/14700000000049-migrate-starting-stock-and-cut-over-to-starshipit-wms
Canonical: https://support.starshipit.com/articles/14700000000049-migrate-starting-stock-and-cut-over-to-starshipit-wms
Markdown: https://support.starshipit.com/articles/14700000000049-migrate-starting-stock-and-cut-over-to-starshipit-wms.md
Updated: 2026-09-15
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Prepare, import, validate, and reconcile starting stock when moving warehouse operations to Starshipit WMS.
Use this guide to move your opening stock into Starshipit WMS, reconcile the result, and switch warehouse operations over at a controlled point in time.
## Before you begin
Complete these checks before preparing the opening balance:
- Make sure your role has the inventory adjustment permission (`inventory.adjust`).
- Sync your product catalogue and resolve missing or duplicate SKUs.
- Configure each product's tracking type before loading stock. Changing a product from Standard to Batch or Serial after the load does not add the missing tracking details.
- Create every warehouse location that will hold opening stock. Confirm each location allows the relevant products and, for a 3PL warehouse, the relevant client stock.
- Convert quantities to the parent product's inventory unit. The Starting Stock page excludes child unit-of-measure products because WMS tracks their inventory against the parent SKU.
- Decide who will approve the final source-system export, who will load it, and who will sign off the WMS result.
- Review the setup guide for your provider in [Understand WMS integrations](/articles/14700000000044-understand-wms-integrations). A successful opening balance creates stock movements that can queue writeback to enabled commerce platforms.
:::warning
Starting Stock adds stock to WMS. It does not replace an existing balance, and there is no user-facing undo or rollback action. Uploading and saving the same quantities again will add them again.
:::
## Prepare the Starting Stock template
1. Go to **Getting started > Bring stock in > Add starting stock**. After onboarding, open **Help > Setup Guide**, then **Bring stock in > Add starting stock**. You can also open [the Starting Stock page](https://wms.starshipit.com/dashboard/setup/starting-stock) directly.
2. Select the **Default location** you want WMS to use while preparing the file.
3. Select **Have a lot of stock? Import via CSV instead**.
4. Select **Download a pre-filled template with your products**.
5. Save an unchanged copy of `starting-stock-template.csv` for reference.
6. Enter the opening quantity and location for each product you want to load. Leave products with no opening stock blank.
WMS automatically fetches all product pages for the template and CSV matching. You do not need to load each product page manually.
The canonical Starting Stock file uses these columns in this order:
| Column | What to enter | How WMS uses it |
| --- | --- | --- |
| `sku` | The exact SKU already synced to WMS. Preserve leading zeros. | Required to match the row to a product in WMS. Matching is not case-sensitive. |
| `product_name` | The pre-filled product name. | For your reference only. WMS does not use it to find the product. |
| `quantity` | A positive whole number. | WMS stages digits only. Blank, zero, negative, and decimal quantities are not saved as starting stock. |
| `location` | The exact name of an existing WMS location. | Matching is not case-sensitive. A blank or unmatched name leaves the product on its current or default location in the form. |
Keep the header row and column order unchanged. The importer reads values by column position and ignores template instruction rows beginning with `#`.
:::caution
Review every location after import. An unknown location name does not reject the row; WMS keeps the location already selected for that product instead.
:::
The Starting Stock template supports one quantity and one location per product. Do not add duplicate rows for a SKU to represent multiple locations. The last matching row replaces the earlier staged value. Use Starting Stock for one location, then add the remaining location balances through **Stock Adjustments**, or use Stock Adjustments for the complete multi-location load.
## Handle batch, serial, and expiry details
The Starting Stock template has no batch number, serial number, or expiry date fields. Keep tracked products out of this file and load them through **Stock Adjustments** so their traceability data is recorded.
:::important
Do not use Starting Stock for batch- or serial-tracked inventory. A serial-tracked row cannot be added without its serial number. A batch-tracked row needs its batch details preserved for later allocation and traceability.
:::
For a small tracked-stock load:
1. Go to **Inventory > Stock Adjustments > Adjustments**.
2. Select the product and its location.
3. Enter a positive quantity change.
4. Select **Stock Receipt**, or your configured opening-balance reason, and enter `Opening Balance` as the reference.
5. For a batch-tracked product, enter the **Batch number** and, when applicable, the **Expiry date** in `DD-MM-YYYY` format.
6. For a serial-tracked product, enter one unique **Serial number** and a quantity of `1`. Add a separate adjustment for every unit.
7. Select **Add adjustment to batch**, review the queued rows, then select **Submit adjustments**.
For a larger tracked or multi-location load, add and validate a representative adjustment, then export the queued batch and use that export as your adjustment CSV template. There is no standalone blank adjustment template. Remove the representative draft before importing if your file includes the same row. The adjustment file supports these opening-balance fields:
| Field | Requirement for an opening balance |
| --- | --- |
| `sku` | Required. Must match an existing parent product. |
| `quantityChange` | Required. Use a positive whole number; use `1` for each serial-tracked unit. |
| `reason` | Required. Use a configured adjustment reason such as `Stock Receipt`. |
| `locationName` | Required. Must match an existing location. |
| `batchNumber` | Required for a batch-tracked product. |
| `expiryDate` | Optional for a batch-tracked product. Use `DD-MM-YYYY`. |
| `serialNumber` | Required for a serial-tracked product and must be unique. |
| `reference` | Use `Opening Balance` to make reconciliation easier. |
Manual adjustment CSV files must be 5 MB or smaller, and each adjustment batch supports up to 200 rows, including rows already queued. Split larger loads into separate batches. Imported rows are validated before they enter the on-screen queue. When you submit the queue, WMS processes each adjustment separately. Some rows can succeed while others fail, so keep the successful rows out of any retry file.
## Rehearse without changing stock
The Starting Stock CSV import is a staging step. Uploading a file fills the on-screen quantities and locations but does not change inventory until you select **Save starting stock**.
Use that staging step as a rehearsal:
1. Make a copy of the migration file.
2. Include representative standard products, locations, and quantity sizes.
3. Upload the copy to Starting Stock without selecting **Save starting stock**.
4. Compare the matched count with the number of positive rows in your file.
5. Review every staged quantity and location, including products beyond the first page.
6. Leave or reload the page to discard the staged values.
7. Import tracked-stock adjustment rows into **Stock Adjustments**, review the queued rows and validation messages, then remove or leave the queue without submitting it.
There is no separate Starting Stock dry-run command. Do not select either save or submit action during the rehearsal.
## Run the operational cutover
Choose a cutover window when stock can stop moving long enough to produce and load one final balance.
1. Finish the rehearsal and resolve every product, location, tracking, and file-format issue.
2. Confirm whether commerce writeback should be enabled during the load. Change the relevant integration settings before the freeze if it should not run.
3. Freeze stock-changing work in the old process and WMS. Pause receiving, putaway, picking, packing and shipping, returns, transfers, stocktakes, and manual adjustments.
4. Complete any in-progress stock movements or return them to a known state.
5. Take the final opening-balance export or signed physical count from the old system. Record the effective date and time.
6. Update the Starting Stock and tracked-stock files from that frozen balance. Do not reuse quantities from the rehearsal.
7. Upload the standard-product file, resolve every skipped row, and review all staged locations and quantities.
8. Select **Save starting stock** once and wait for the success message.
9. Load the batch-, serial-, and multi-location adjustment rows. Review successful and failed adjustment counts before retrying anything.
10. Reconcile WMS against the frozen balance before allowing stock to move again.
## Reconcile the opening balance
1. Go to the **Inventory** dashboard and refresh the data.
2. Export the stock-on-hand report.
3. Compare WMS with the frozen source balance by SKU and location, then compare the warehouse-wide total for each SKU.
4. Spot-check batch numbers, expiry dates, and individual serial numbers for every tracked-product type used in your warehouse.
5. Review **Stock Movements**. Starting Stock movements use the reason `Stock Receipt` and reference `Opening Balance`.
6. Review **System > Process Logs** for any commerce inventory writeback failures.
7. Investigate every difference and record the correction before signing off.
8. If needed, run a manual bulk commerce sync after WMS is correct so the connected platform receives the reconciled on-hand quantity.
9. Resume warehouse operations and connected-system processing only after the opening balance is approved.
## Correct errors and rerun safely
Use the result in WMS, not the original upload message alone, to decide what to do next.
| Result | Safe next action |
| --- | --- |
| The CSV reports skipped or invalid rows before save | Correct the source file, re-import it, and review all staged values. No stock has changed yet. |
| **Save starting stock** returns an error | Check Inventory and Stock Movements for `Opening Balance` records before retrying. If none were created, correct the reported product or location problem and retry only after confirming the balance is unchanged. |
| The save result is uncertain because the browser or connection failed | Reconcile WMS first. Do not upload the full file again until you know which movements exist. |
| A row was omitted from a successful load | Add only the confirmed missing quantity. Do not include previously successful rows. |
| A quantity or location was saved incorrectly | Use **Inventory > Stock Adjustments > Adjustments** for a known correction, or **Inventory > Stocktakes** to reconcile a physical count. Keep `Opening Balance correction` in the reference for the audit trail. |
| A manual adjustment batch partially succeeds | Remove successful rows from the retry file and resubmit only the failed rows after correcting them. |
| The full Starting Stock file was saved twice | Do not delete movement history. Post reviewed opposite adjustments for the duplicated quantities and reconcile again. |
WMS plans and validates all rows in a Starting Stock save before applying them. Its inventory database writes then run together, so a validation or database failure does not leave part of that Starting Stock batch applied. This is not an undo or rollback feature you can invoke, and a successful save cannot be undone. Corrections create new stock movements so the original opening balance and the correction remain visible in the audit trail.
Commerce writeback is outside the opening-balance inventory transaction. A writeback failure does not reverse stock already saved in WMS. Resolve the WMS balance first, then investigate or rerun the commerce sync separately.
## Related articles
- [Products and inventory configuration](/articles/14700000000006-starshipit-wms-products-and-inventory-configuration)
- [Locations and warehouse setup](/articles/14700000000033-starshipit-wms-locations-and-warehouse-setup)
- [Inventory dashboard and stock visibility](/articles/14700000000014-inventory-dashboard-and-stock-visibility)
- [Stock integrity and adjustments](/articles/14700000000020-stock-integrity-and-adjustments)
- [Understand WMS integrations](/articles/14700000000044-understand-wms-integrations)
---
# Understand WMS terms and key concepts
URL: https://support.starshipit.com/articles/14700000000003-understand-wms-terms-and-key-concepts
Canonical: https://support.starshipit.com/articles/14700000000003-understand-wms-terms-and-key-concepts
Markdown: https://support.starshipit.com/articles/14700000000003-understand-wms-terms-and-key-concepts.md
Updated: 2026-09-11
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> A reference guide to stock statuses, location types, job types, tracking types, allocation strategies, and other key WMS terms.
This guide explains the core terms and concepts used throughout Starshipit WMS. If you are new to WMS — or explaining it to someone on your team — this is a good place to start.
## Stock statuses
These four figures appear on the inventory dashboard for every SKU:
| Status | What it means |
| ------ | ------------- |
| **On hand** | Total physical quantity in the warehouse across all locations. |
| **Committed** | Quantity required to fulfil all open orders that are not yet shipped. Stock is committed as soon as an order arrives in WMS. |
| **Available** | Stock that can still be sold or allocated: *On hand − Committed*. A negative available figure means demand exceeds current stock. |
| **Incoming** | Quantity on open purchase orders that has been ordered but not yet received. |
| **Allocated** | Stock formally reserved in active pick jobs for orders that have been released. An order may be committed but not yet allocated if it has not been released to the warehouse. |
## Order statuses
Orders in WMS move through the following statuses:
| Status | What it means |
| ------ | ------------- |
| **PENDING** | Order has arrived from Starshipit but has not yet been released to the warehouse. |
| **RELEASED** | Order has been released. Stock is allocated and pick jobs have been created. |
| **PARTIALLY\_SHIPPED** | Some items have been shipped; others are still outstanding. |
| **SHIPPED** | Order has shipped in full. Stock movements have been finalised. |
## Location types
Location types tell WMS how each physical area in your warehouse is used:
| Type | Used for |
| ---- | -------- |
| **Pick Face** | Forward-picking bins for fast, efficient picking. Usually holds smaller quantities and is restocked from bulk when it runs low. |
| **Bulk Storage** | Reserve stock, typically in higher shelves or pallet areas, used to replenish pick faces. |
| **Staging Dock** | Where inbound stock lands before being put away to final locations. |
| **Packing Bench** | Where orders are packed and shipping labels are printed. |
| **Equipment** | A picker's cart, trolley or tote. Stock moves into equipment locations during picking, before being staged to a bench. |
| **Returns** | Holding area for items returned by customers. |
| **Damaged** | Items confirmed as unsellable, pending write-off or disposal. |
| **Quarantine** | Items under investigation (quality issue, recall, supplier claim, etc.). |
| **Quality Control** | Inspection and verification areas. |
| **Shipping Dock** | Dispatch areas for outbound parcels. |
## Tracking types
Each product has one of three tracking types, which controls what data is required when stock is received, picked or adjusted:
| Type | How it works |
| ---- | ------------ |
| **Standard** | Inventory tracked by quantity only. No batch or serial identifiers required. Most products use this. |
| **Batch** | Stock tracked by lot or batch number. Used for products with expiry dates (food, pharmaceuticals, cosmetics) or traceability requirements. WMS prompts for a batch number during receiving and optionally records an expiry date. |
| **Serial** | Each individual unit has a unique serial number. WMS requires one serial number per unit during receiving and tracks movements per serial. Used for high-value electronics, regulated goods, or items requiring unit-level traceability. |
## Allocation strategies
Allocation strategies control which specific stock is reserved when an order is released. Configured per product:
| Strategy | How it works |
| -------- | ------------ |
| **FIFO** — First In, First Out | Allocates the oldest stock first (based on when it was received). The default setting and suits most non-perishable products. |
| **LIFO** — Last In, First Out | Allocates the newest stock first. Used in specific scenarios where newer stock is more accessible. |
| **FEFO** — First Expiry, First Out | Allocates stock with the nearest expiry date first. Used with batch-tracked products to reduce waste from expired stock. |
| **LEFO** — Last Expiry, First Out | Allocates stock with the furthest expiry date first. Used when you intentionally want to ship the longest-dated stock first. |
## Job types
Jobs are tasks created by WMS and assigned to warehouse staff. Each job type corresponds to a specific workflow:
| Job type | What it does |
| -------- | ------------ |
| **Pick job** | Instructs a picker to collect specific items from specific locations. Created when an order is released or when using expedited fulfilment. |
| **Batch pick job** | A single job covering picks for multiple orders. Reduces warehouse travel by combining similar picks. |
| **Pack job** | Ready for a packer to verify items, box them, and generate a shipping label. Created after picking is complete. |
| **Putaway job** | Moves received stock from a staging area to final storage locations. Created after stock is received into a staging dock. |
| **Replenishment job** | Moves stock from bulk storage to a pick face when that location runs low. Created automatically when capacity rules trigger, or manually from the replenishment dashboard. |
| **Kitting job** | Assembles component SKUs into a bundle product. Created when a require-stock bundle needs restocking. |
| **Cycle count job** | A count for product inventory at a location. Create one manually for one product at one eligible location from the WMS web **Cycle Count** dashboard, or let WMS create one when a worker reports a discrepancy during warehouse work. |
## Bundle types
WMS supports two types of bundle products:
| Type | How it works |
| ---- | ------------ |
| **Exploding bundle** | The bundle SKU breaks into its component SKUs when an order is processed. WMS picks and tracks individual components. Inventory is held at the component level. |
| **Require-stock bundle** | The bundle SKU has its own on-hand inventory. It behaves like a physical item on the shelf. When bundle stock is needed, a kitting job is created to assemble it from components. |
## Purchase order statuses
| Status | What it means |
| ------ | ------------- |
| **DRAFT** | PO is being prepared and not yet issued to the supplier. |
| **CREATED** | PO has been issued and is awaiting delivery. |
| **PARTIALLY\_RECEIVED** | Some lines or quantities have arrived; more are still expected. |
| **RECEIVED** | All lines and quantities have been fully received. |
---
# Set up Cin7 Omni with Starshipit WMS
URL: https://support.starshipit.com/articles/14700000000053-set-up-cin7-omni-with-starshipit-wms
Canonical: https://support.starshipit.com/articles/14700000000053-set-up-cin7-omni-with-starshipit-wms
Markdown: https://support.starshipit.com/articles/14700000000053-set-up-cin7-omni-with-starshipit-wms.md
Updated: 2026-09-07
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Import or schedule Cin7 Omni products in Starshipit WMS and configure branch-aware inventory writeback for linked products.
Connect Cin7 Omni through Starshipit's legacy integration settings, import Cin7 Omni products into Starshipit WMS, and write WMS inventory back to a selected Cin7 Omni branch.
Starshipit WMS uses the Cin7 Omni public API credentials saved in Starshipit. It does not use the dedicated Cin7 Omni API connection.
## Before you begin
You need:
* A Cin7 Omni account connected to the current Starshipit account using the legacy Cin7 integration and public API credentials.
* Permission to manage products and commerce settings in WMS.
* Unique, non-empty SKUs on the Cin7 Omni products you want to manage.
* An active Cin7 Omni branch that will receive WMS inventory updates.
If the legacy Cin7 integration is already connected using public API credentials, continue to [Import products from Cin7 Omni](#import-products-from-cin7-omni).
:::important
The **Use dedicated API (recommended)** option in Starshipit does not support this WMS workflow. Cin7 Omni and Cin7 Core also use different WMS integrations. Use [Set up Cin7 Core with Starshipit WMS](/articles/14700000000035-set-up-cin7-core-with-starshipit-wms) if your account uses Cin7 Core or DEAR Inventory.
:::
## Configure the legacy Cin7 Omni connection
1. In Cin7 Omni, select the settings cogwheel.
2. Go to **Integrations > API v1**.
3. Copy the **API Username** shown on the **API Setup** page.
4. Select **Add New API Connection**.
5. Enter a name for the connection, such as `Starshipit`, then save it.
6. Copy the **API Key** from the confirmation page. This is the **API connection key** you will enter in Starshipit. Store it securely because Cin7 Omni will not display it again.
7. On the **API Connections** page, select **Permissions** for the new Starshipit connection.
8. Enable these permissions:
| Cin7 Omni resource | Permissions |
| --- | --- |
| **Branches** | **Read** |
| **Products** | **Read** |
| **Product Options** | **Read** |
| **Stock** | **Read** |
| **Adjustments** | **Create**, **Read**, **Update** |
| **Sales Orders** | **Create**, **Read**, **Update** |
9. Select **Save**.
10. In Starshipit, go to **Settings > Integrations > Add New > Cin7 Omni**.
11. Turn on **Enable Cin7 Omni**, select **Use Public API (deprecated)**, then enter the API username and connection key.
12. Test the connection, then select **Save**.
For more information about the legacy connection, see [Connect legacy Cin7 to Starshipit](/articles/217503906-connect-legacy-cin7-to-starshipit).
## Import products from Cin7 Omni
1. Go to **Products** in WMS.
2. Open the actions menu and select **Sync from Cin7 Omni**.
3. Choose the product fields to import.
4. Optionally enter SKU filters to limit the import.
5. Select **Start Sync**.
6. Review the result, then open a product and confirm its Cin7 Omni source and SKU.
You can also open the import dialog from **System > Settings > Product Syncs**, under **Cin7 Omni Product Sync > Configure**.
Products are matched by SKU. The import creates the Cin7 Omni product link used for inventory writeback.
### Schedule a nightly product sync
Users with account-wide **Products management** and **Settings management** access can turn on a full nightly import.
1. Go to **System > Settings > Product Syncs**.
2. Find **Cin7 Omni Product Sync**.
3. Turn on **Daily product import**.
You can also change this setting using **Sync products nightly** in the **Sync from Cin7 Omni** dialog on the Products page.
The scheduled run imports the full Cin7 Omni catalogue using the standard product fields. It does not reuse the fields, SKU filters, page number, or variant-title option from a manual sync. If another Cin7 Omni product sync is already active, WMS skips that night's run instead of starting a duplicate.
## Configure Cin7 Omni inventory writeback
1. Go to **System > Settings > Inventory Writeback**.
2. Find **Cin7 Omni Inventory Sync**.
3. Select the Cin7 Omni branch that should receive WMS stock changes.
4. Turn on **Auto writeback**.
Only products connected to Cin7 Omni are written to the selected branch.
This commerce integration handles product import and inventory writeback. It does not provide the direct catalogue, Advanced Purchase order, webhook and reconciliation flows available in the separate Cin7 Core integration.
## Understand automatic writeback
After a supported receipt, pick, shipment, manual adjustment or stocktake variance completes, WMS queues the Cin7 Omni update in the background. The warehouse transaction does not wait for Cin7 Omni and is not rolled back if the update fails.
WMS processes automatic and manual writebacks at the next 30-minute boundary, around `:00` or `:30` past each hour. It reads the latest on-hand quantity when the batch runs and sends that quantity to the selected Cin7 Omni branch.
You can disable Cin7 Omni writeback for an individual product when WMS should not manage that product's branch inventory.
## Run a manual inventory writeback
1. Go to **Inventory**.
2. Select the Cin7 Omni-linked products you want to update.
3. Select **Writeback to Cin7 Omni**.
4. Review the products and current WMS quantities.
5. Select **Sync to Cin7** to queue the writeback.
6. Go to **System > Process Logs** and confirm the updates completed.
Products without an enabled Cin7 Omni link are skipped.
## Verify the integration
1. Import a test product from Cin7 Omni.
2. Select the writeback branch.
3. Enable **Auto writeback**.
4. Complete a controlled stock adjustment in WMS.
5. Confirm the quantity changed in the selected Cin7 Omni branch.
6. Check **System > Process Logs** for the Cin7 Omni result.
## Troubleshooting
| Problem | What to check |
| --- | --- |
| Cin7 Omni does not appear in WMS settings | Confirm the legacy Cin7 integration is enabled for the current Starshipit account and **Use Public API (deprecated)** is selected, then refresh the settings page. |
| No branches are available | Confirm the public API username and connection key are saved and the connected Cin7 Omni account has an active branch, then refresh **Cin7 Omni Inventory Sync**. |
| **Auto writeback** is unavailable | Select an active Cin7 Omni branch first. |
| A product is skipped | Confirm it was imported or linked to Cin7 Omni and its provider writeback has not been disabled. |
| A quantity does not change | Confirm the selected branch is correct and check **System > Process Logs** for the returned Cin7 Omni error. |
| You expected purchase orders or stock reconciliation | Confirm whether your system is Cin7 Omni or Cin7 Core. Those direct flows are available only for Cin7 Core. |
If the problem continues, contact [Starshipit support](https://help.starshipit.com) with the WMS account, Cin7 Omni branch, SKU and approximate time of the sync.
## Related articles
* [Understand WMS integrations](/articles/14700000000044-understand-wms-integrations)
* [Configure WMS products and inventory](/articles/14700000000006-starshipit-wms-products-and-inventory-configuration)
* [Maintain stock accuracy and make adjustments](/articles/14700000000020-adjust-stock-and-investigate-stock-movements)
---
# Understand WMS integrations
URL: https://support.starshipit.com/articles/14700000000044-understand-wms-integrations
Canonical: https://support.starshipit.com/articles/14700000000044-understand-wms-integrations
Markdown: https://support.starshipit.com/articles/14700000000044-understand-wms-integrations.md
Updated: 2026-09-08
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Compare the WMS connection options for Starshipit, commerce platforms, inventory systems, and ERP platforms.
Starshipit WMS works with your Starshipit account and its connected commerce or inventory systems. Choose an integration based on which system owns your products, purchase orders and inventory.
## Understand the available WMS connections
In addition to its core Starshipit account connection, WMS has one direct inventory-system integration and nine connections through Starshipit. A sales channel can still connect to Starshipit for orders and shipping even when it is not listed below for WMS product and inventory synchronisation.
| Connection | WMS capabilities | Setup guide |
| --- | --- | --- |
| **Starshipit WMS** | Connects WMS to Starshipit so orders, shipments and warehouse activity can work together. | [Set up Starshipit WMS](/articles/14700000000002-set-up-starshipit-wms) |
| **Shopify** | Product import, scheduled daily product import, per-store and per-location inventory writeback, location buckets, exploding-bundle availability and manual inventory sync. | [Set up Shopify with Starshipit WMS](/articles/14700000000018-set-up-shopify-with-starshipit-wms) |
| **BigCommerce** | Product import and per-store, per-location automatic or manual inventory writeback for linked products. | [Set up BigCommerce with Starshipit WMS](/articles/14700000000050-set-up-bigcommerce-with-starshipit-wms) |
| **WooCommerce** | Product import and automatic or manual inventory writeback for linked products. | [Set up WooCommerce with Starshipit WMS](/articles/14700000000051-set-up-woocommerce-with-starshipit-wms) |
| **Adobe Commerce (Magento 2)** | Product import and per-store, per-location automatic or manual inventory writeback for linked products. | [Set up Adobe Commerce with Starshipit WMS](/articles/14700000000052-set-up-adobe-commerce-magento-2-with-starshipit-wms) |
| **Cin7 Omni** | Product import and branch-aware automatic or manual inventory writeback for linked products. | [Set up Cin7 Omni with Starshipit WMS](/articles/14700000000053-set-up-cin7-omni-with-starshipit-wms) |
| **Unleashed** | Purchase-order import and SKU-based automatic or manual inventory writeback to a selected warehouse. | [Set up Unleashed with Starshipit WMS](/articles/14700000000054-set-up-unleashed-with-starshipit-wms) |
| **MYOB Acumatica** | Product import and manual reconciliation of WMS on-hand inventory to one selected Acumatica warehouse. | [Set up MYOB Acumatica with Starshipit WMS](/articles/14700000000056-set-up-myob-acumatica-with-starshipit-wms) |
| **NetSuite** | Exact-SKU product linking and automatic or manual reconciliation of account-wide WMS on-hand inventory to one NetSuite location. | [Set up NetSuite with Starshipit WMS](/articles/14700000000058-set-up-netsuite-with-starshipit-wms) |
| **Etsy** | Product import and automatic or manual inventory writeback for linked variants. | [Set up Etsy with Starshipit WMS](/articles/14700000000057-set-up-etsy-with-starshipit-wms) |
| **Cin7 Core** | Direct product and purchase-order imports, bin-stock reconciliation, inventory writeback and optional outbound Pick/Pack. | [Set up Cin7 Core with Starshipit WMS](/articles/14700000000035-set-up-cin7-core-with-starshipit-wms) |
For sales channels and systems that are not part of the WMS inventory-sync list, see [Connect sales channels and systems](/categories/integrations). Those connections can still bring orders into Starshipit for shipping.
## Understand the integration types
The Cin7 Core direct integration has its own credentials, warehouse mapping and webhook lifecycle inside WMS. It can import Advanced Purchase orders and reconcile stock by linked bin in one mapped Cin7 Core warehouse. Optional writeback sends receipts, adjustments and bin movements to Core; a separate setting enables Pick/Pack for eligible sales.
The nine Starshipit-backed connections use integrations already connected to Starshipit. Product imports, product linking, purchase-order imports, and inventory writeback depend on the provider and the mapping described in each guide.
Where supported, automatic commerce writeback runs after the WMS stock movement completes. A provider error does not undo the warehouse receipt, pick, shipment, adjustment or stocktake variance. Review failed updates in **System > Process Logs**.
## Choose an operating model
| Need | Guide |
| --- | --- |
| Keep selected workflows in Starshipit | [Run WMS alongside Starshipit](/articles/14700000000004-running-wms-alongside-starshipit-hybrid-outbound-headless-mode) |
| Run a shared 3PL operation | [Set up WMS for a 3PL](/articles/14700000000032-wms-for-3pls-suggested-setup-guide) |
## Before you enable synchronisation
Decide which system is the source of truth for products and inventory. Test a new integration with a small set of products, stock movements and purchase orders before relying on it for live operations. Review the relevant controls in [WMS settings reference](/articles/14700000000031-wms-settings-reference).
---
# Set up warehouse locations and work areas
URL: https://support.starshipit.com/articles/14700000000033-set-up-warehouse-locations-and-work-areas
Canonical: https://support.starshipit.com/articles/14700000000033-set-up-warehouse-locations-and-work-areas
Markdown: https://support.starshipit.com/articles/14700000000033-set-up-warehouse-locations-and-work-areas.md
Updated: 2026-09-08
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Set up warehouse locations including pick faces, bulk storage, staging docks, packing benches, and equipment to control stock accuracy and streamline picking.
The **Locations** section in Starshipit WMS is where you build the physical layout of your warehouse. Locations represent bins, shelves, zones, benches and other areas where stock is stored, processed or moved.
Correctly setting up locations helps control stock accuracy, streamline picking routes and support key workflows such as receiving, replenishment and packing.
Starshipit WMS supports any type of warehouse layout, from simple shelf-and-bin setups to more complex multi-zone operations.
## Location types
Location types help the WMS understand how each location is used. This allows the system to allocate, pick and move stock appropriately.
| Location type | Description |
| --- | --- |
| **Pick Face** | A forward-picking location used for fast, efficient picking. These locations usually contain smaller quantities of stock and are restocked from bulk storage when they run low. |
| **Bulk Storage** | Holds larger quantities of stock. Typically higher shelves, pallets, or reserve areas used to replenish pick faces. |
| **Staging Dock** | Used for inbound receiving. Stock received into staging can later be put away to final storage via a putaway job. |
| **Packing Bench** | Represents packing stations. Picked items are moved here before packing and shipping. |
| **Equipment** | Represents carts, totes, or similar containers used during picking. Items may move from a shelf location into an equipment location before being staged to a packing bench. |
| **Quality Control** | Inspection or verification areas. |
| **Returns/Damaged** | For returned or non-saleable items. |
| **Quarantine** | Items on hold or restricted. |
| **Shipping Dock** | Dispatch areas. |
## Creating and managing locations
To add locations in Starshipit WMS:
1. Go to the **Locations** section.
2. Click **Create location**.
3. Enter a name or code (e.g., *A1-01*, *Bulk-01*, *Pack-02*).
4. Select the location type.
5. (Optional) Add capacity information.
6. (Optional) Add a **barcode** for scanning workflows.
7. (Optional) Add a **sequence** value to control pick-path or display order.
8. Save the location.
You can create as many locations as needed. Most warehouses use a structured naming convention such as:
* **Zone – Aisle – Bay – Shelf** (e.g., A-03-02-04)
* **Bulk or Pallet areas** (e.g., BULK-01, PALLET-05)
* **Packing stations** (e.g., PACK-01, PACK-02)
Locations can be edited at any time to adjust attributes such as type or capacity. The WMS keeps full movement logs for all inventory stored in each location.
Use **Delete** only for an unused location with no inventory or movement history. When history prevents deletion, the row action changes to **Archive**. Archiving keeps the audit trail but removes the location from operational selectors and normal inventory, allocation, receiving, picking, packing, tote, container, reporting, onboarding, and commerce workflows. Use the **Archived** filter to switch between Active, Archived, and All locations.
The locations list shows each location's type, barcode, zone, sequence and current inventory at a glance.
## Location attributes and layout tools
In addition to core fields like name and type, locations support extra attributes that improve scanning and navigation:
* **Barcodes** – scan to quickly select a location during receiving, putaway, picking, or stocktakes.
* **Sequence values** – control the order locations appear in lists or pick paths.
* **Zones** – group locations by physical area, client, temperature area, or operational workflow.
WMS also supports **visual location layout customisation**, which helps teams map bins, shelves, or zones to a warehouse floor plan. Use this when you want a more visual way to identify where stock should be stored or picked.
### Importing locations via CSV
You can also import locations in bulk using a CSV file. The CSV import supports parent-child relationships, so child rows can reference parent rows in the same file. This is useful when setting up a new warehouse or adding a large number of bins at once.
If your account uses the direct Cin7 Core integration, **Import from Cin7 Core** can copy active locations beneath the mapped Core warehouse into WMS as pick faces. Existing same-name WMS locations keep their type and settings. The import creates stable Core bin links used for inventory reconciliation and writeback. Later Core location changes are not imported automatically. Link receiving, staging, equipment and packing locations before using bin-based movements. See [Set up Cin7 Core with Starshipit WMS](/articles/14700000000035-set-up-cin7-core-with-starshipit-wms#map-the-warehouse-and-import-locations).
### Searchable location dropdown
The location dropdown throughout the application is a searchable select. You can type to filter locations by name rather than scrolling through a long list. This applies wherever you need to choose a location (receiving, putaway, stock movements, stocktake, etc.).
## Location barcodes
Each location can have a **barcode** assigned. This allows warehouse staff to scan location barcodes during picking, putaway and stocktake operations for faster and more accurate confirmation.
To assign a barcode to a location, open the location record and enter or scan the barcode value.
To print one location label, open the row actions and select **Print barcode**. For several locations, select up to 100 rows and choose **Print barcodes**. Preview the labels and choose sheet, 101 x 48 mm, 57 x 32 mm, or 100 x 50 mm layout before printing. WMS remembers the chosen layout in that browser.
## Location sequence
Locations have a configurable **sequence number** that determines their order in pick lists and other location-ordered views. Setting sequence numbers allows you to control the route pickers follow through the warehouse, reducing travel time.
## Location layout visualisation
A **visualisation view** is available that displays your warehouse location layout graphically. The visualisation is customisable — you can adjust how locations are displayed and arranged to match your physical warehouse layout.
This is useful for planning location structures, identifying spare capacity, and communicating the warehouse layout to new staff.
## Bulk location management
Use bulk selection when you need to clean up a group of unused locations. Bulk delete is intended for locations that are no longer needed and do not contain active stock or open work. Review the selected locations carefully before deleting them.
## Parent locations and tote assignment
Locations support a **parent-child hierarchy**. The key use case is assigning totes to equipment. For example, a picking cart (equipment location) can have multiple totes assigned as child locations.
* Equipment totes are ordered by their sequence number.
* Tote sequence is preserved across pages and refreshes.
* CSV import of locations supports parent-child relationships.
This helps model multi-compartment picking carts where each tote represents a separate compartment or order container.
## Location capacity and replenishment triggers
Pick faces can optionally store minimum and maximum capacity values.
* **Minimum level** – when stock falls below this threshold, the system can trigger a replenishment job.
* **Maximum level** – the ideal upper limit when topping up stock from bulk.
Replenishment jobs help ensure pick faces always have enough stock to fulfil orders efficiently without overstocking.
## Restricting products to locations
Some products need to be stored only in specific areas—for example:
* Hazardous goods
* Temperature-controlled items
* High-value items
* Oversized stock
In Starshipit WMS, you can restrict which products can be stored in each location:
1. Open a location.
2. Select **Allowed products**.
3. Add the SKUs that can be stored there.
Restricted locations prevent receiving, putaway or replenishment from placing stock where it does not belong.
## Multi-warehouse and child account support
If your business uses multiple Starshipit child accounts, Starshipit WMS can support multiple warehouse environments. Each Starshipit account can map to its own WMS instance with its own locations and stock.
Alternatively, you can share a single WMS instance across multiple child accounts using the **WMS Override** option in the Starshipit integration settings. This is useful when multiple storefronts fulfil from the same physical warehouse.
For 3PL or shared warehouse models, use zones, location naming, and product client scoping together. This makes it easier to keep client stock separated while still letting warehouse staff work from one operational view.
## Best-practice setup
* **Define zones clearly.**
Group bulk, pick face, packing and staging areas logically to reduce travel time and keep processes organised.
* **Use consistent naming conventions.**
Clear naming makes picking lists understandable and helps onboard new staff quickly.
* **Keep pick faces small and replenished from bulk.**
This improves picking speed while keeping safety stock in the bulk area.
* **Use staging for large inbound receipts.**
Staging lets you receive deliveries quickly and handle putaway separately.
* **Set capacity values for high-volume SKUs.**
This allows the system to generate replenishment jobs before a pick face runs empty.
* **Create dedicated packing benches.**
This keeps stock movements clean (picked → equipment → packing bench → shipped).
## FAQ
Do I have to use all location types?
No. You can use only the location types relevant to your warehouse. For example, small operations may have just pick faces, bulk storage and a packing area.
Can I change a location type later?
Yes, but changing a location type with existing stock may affect workflows (for example, turning a bulk location into a pick face). Review stock and operations before making changes.
Does the WMS support multiple warehouses?
Yes. Each Starshipit account has its own WMS instance, and you can optionally point multiple accounts to a shared WMS environment if needed.
What happens if a product is restricted from a location?
The WMS will prevent receiving, putaway or replenishment jobs from placing that product in the restricted location.
Can I assign barcodes to locations?
Yes. Each location can have a barcode assigned, which can be scanned during picking, putaway and stocktake to speed up operations and reduce errors.
How granular should locations be?
Most warehouses use shelf-level or bin-level granularity. More detailed locations increase accuracy but require more scanning, so choose a level that matches your operating style.
---
# Set up Shopify with Starshipit WMS
URL: https://support.starshipit.com/articles/14700000000018-set-up-shopify-with-starshipit-wms
Canonical: https://support.starshipit.com/articles/14700000000018-set-up-shopify-with-starshipit-wms
Markdown: https://support.starshipit.com/articles/14700000000018-set-up-shopify-with-starshipit-wms.md
Updated: 2026-08-10
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Import Shopify products into Starshipit WMS and keep inventory aligned with per-store writeback, location buckets and manual syncs.
Connect Shopify through Starshipit, import Shopify products into Starshipit WMS, and choose how WMS writes inventory back to each Shopify store and location.
## Before you begin
You need:
* A Shopify store connected to the current Starshipit account, its parent account or an eligible child account.
* Permission to manage products and commerce settings in WMS.
* Unique, non-empty SKUs on the Shopify variants you want to manage.
* A Shopify location for each store that will receive WMS inventory updates.
If Shopify is not connected yet, [connect Shopify to Starshipit](/articles/90200000000202-connect-shopify-to-starshipit) first.
:::important
Decide whether WMS or another system owns Shopify inventory before enabling writeback. WMS can overwrite the available quantity at the selected Shopify location.
:::
## Import products from Shopify
Importing from Shopify creates the product links WMS needs for inventory writeback.
1. Go to **Products** in WMS.
2. Open the actions menu and select **Sync from Shopify**.
3. Select the Shopify store when more than one store is available.
4. Choose the product fields to import.
5. Optionally enter SKU filters or limit the import to active or published Shopify products.
6. Select **Start Sync**.
7. Review the result, then open a product and confirm its Shopify source and SKU.
Products are matched by SKU. Review duplicate or missing SKUs before relying on the imported catalogue.
If the same SKU is sold in more than one Shopify store, import it from each store. WMS keeps one product record and adds a separate Shopify link for each store. Configure the writeback location and inventory settings for every linked store that WMS should update.
### Import Shopify bundle configurations
Turn on **Import Shopify bundles** when you want WMS to import native Shopify bundle components and configure the matching WMS products as exploding bundles.
The import must process the complete Shopify catalogue so WMS can import every bundle and component before applying the configuration. Leave the page number empty when this option is on. Review any skipped bundles or warnings after the import completes.
### Schedule a daily product import
1. Go to **System > Settings > Product Syncs**.
2. Find **Shopify Product Sync**.
3. Turn on **Run Daily Sync for the selected store** for each store that WMS should refresh overnight.
4. If required, turn on **Import Shopify bundles**.
5. Select **Save daily sync config** to save the stores, filters, fields and bundle option used overnight.
You can also save the selected store and active or published filters when you run a Shopify product sync.
## Configure Shopify inventory writeback
1. Go to **System > Settings > Inventory Writeback**.
2. Find **Shopify Inventory Sync**.
3. Select the **Writeback Location** for each source store.
4. Turn on **Auto Writeback** for the stores WMS should update.
5. Optionally turn on **Location buckets** or **Exploding bundles** for a store.
| Setting | What it does |
| --- | --- |
| **Writeback Location** | Chooses the Shopify location that receives inventory updates for products from that source store. |
| **Auto Writeback** | Queues a Shopify inventory update after supported WMS stock movements. |
| **Location buckets** | Maps WMS quarantine and quality control stock to Shopify quality control inventory, damaged returns to damaged inventory, and transfers between those location groups to matching Shopify buckets. |
| **Exploding bundles** | Sets a linked bundle parent's Shopify availability from sellable component stock after pending and released order demand. |
**Location buckets** requires **Auto Writeback**. **Exploding bundles** works independently and can remain on while normal automatic writeback is off.
See [Sync exploding bundle availability to Shopify](/articles/14700000000048-sync-exploding-bundle-availability-to-shopify) for the bundle calculation and verification steps.
## Understand automatic writeback
After a supported receipt, pick, shipment, manual adjustment or stocktake variance completes, WMS queues the Shopify update in the background. The warehouse transaction does not wait for Shopify and is not rolled back if Shopify rejects the update.
Only products with a Shopify inventory link and an enabled store mapping are written back. A product linked to multiple enabled Shopify stores is queued for each linked store. You can disable Shopify writeback for an individual product when WMS should not manage that product's Shopify inventory.
## Run a manual inventory sync
Use a manual sync after a stocktake, during go-live, or when you need to correct drift.
1. Go to **Inventory**.
2. Select the linked products you want to update.
3. Select **Sync to Shopify**.
4. Review the products and quantities in the confirmation window.
5. Select **Queue writeback**.
6. Go to **System > Process Logs** and confirm the queued updates completed.
The manual action sends each selected product's current WMS on-hand quantity to its configured Shopify targets. Products without a Shopify inventory link are skipped.
## Verify the integration
1. Import a test product from Shopify.
2. Select its store and writeback location in **Inventory Writeback**.
3. Enable **Auto Writeback**.
4. Complete a controlled stock adjustment in WMS.
5. Confirm the quantity changed at the selected Shopify location.
6. Check **System > Process Logs** for the Shopify writeback result.
## Troubleshooting
| Problem | What to check |
| --- | --- |
| Shopify does not appear in WMS settings | Confirm Shopify is connected to the current or eligible related Starshipit account, then refresh the settings page. |
| A store has no writeback controls | Import products from that Shopify store so WMS can create source-store mappings. |
| A product is skipped | Confirm it was imported from Shopify, has a Shopify inventory link and has not had Shopify writeback disabled. |
| **Auto Writeback** is unavailable | Select an active **Writeback Location** first. |
| The wrong Shopify location changes | Check the writeback location for the product's source store, including parent or child account mappings. |
| A writeback remains missing | Check **System > Process Logs** for a missing link, removed location, rate limit or Shopify API error. |
If the problem continues, contact [Starshipit support](https://help.starshipit.com) with the WMS account, Shopify store, SKU, selected location and approximate time of the sync.
## Related articles
* [Understand WMS integrations](/articles/14700000000044-understand-wms-integrations)
* [Configure WMS products and inventory](/articles/14700000000006-starshipit-wms-products-and-inventory-configuration)
* [Maintain stock accuracy and make adjustments](/articles/14700000000020-adjust-stock-and-investigate-stock-movements)
---
# Set up WMS users, roles and client access
URL: https://support.starshipit.com/articles/14700000000036-set-up-wms-users-roles-and-client-access
Canonical: https://support.starshipit.com/articles/14700000000036-set-up-wms-users-roles-and-client-access
Markdown: https://support.starshipit.com/articles/14700000000036-set-up-wms-users-roles-and-client-access.md
Updated: 2026-09-04
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Choose WMS roles, customise user permissions, limit 3PL client access, and resolve missing pages or actions.
Use WMS roles and permissions to give each warehouse user the access they need, while limiting selected users to specific clients in a shared 3PL workspace. WMS supports both Starshipit-backed users and WMS-local workers who do not need an email address or Starshipit login.
## Understand the two access layers
Starshipit account membership and WMS authorization are separate:
- **Starshipit account membership** controls the user's login and which Starshipit account they belong to.
- **WMS authorization** controls which WMS pages, records, job types, and actions that user can access.
Adding a WMS role does not create a Starshipit login. Removing a WMS role does not remove the user from your Starshipit account.
When you select **Sync Users**, WMS adds new users from the Starshipit account without changing existing WMS role assignments. The primary account is assigned **Admin** by default, while new Starshipit user accounts are assigned **Operator** by default. Review these defaults before users begin work.
The **Roles & Permissions** page shows each person's role, client access and effective permission count before you open their detailed assignment.
## Before you begin
To manage WMS access, you need:
- The **Admin** role, or the custom `staff.manage` permission.
- Access to all clients. A client-scoped user cannot manage roles, even if they have `staff.manage`.
- Existing Starshipit account membership for each Starshipit-backed user. WMS-local workers are created separately in **Roles & Permissions**.
- Active WMS client records if you want to limit access by client.
## Choose a standard role
Each user has one of seven standard roles. The role supplies a set of default permissions.
| Role | Default access | Best suited to |
| --- | --- | --- |
| **Admin** | All WMS permissions, including settings, roles, products, locations, reporting, and every job type. | WMS owners and system administrators. |
| **Supervisor** | All operational job types; view all jobs; create, assign, release, and complete work; manage inventory, locations, purchase orders, fulfilment, and stock movements; view settings, staff, and process logs. It does not manage roles, settings, or products by default. | Warehouse managers and shift supervisors. |
| **Operator** | All operational job types; claim and complete work; adjust and move inventory; view products, locations, purchase orders, and stock movements. | Cross-trained warehouse operators. |
| **Picker** | Claim and complete picking work, with read access to products, inventory, and locations. | Team members who only pick orders. |
| **Packer** | Claim and complete packing work, with read access to products, inventory, and locations. | Team members who pack and ship orders. |
| **Receiver** | Receive stock, complete putaway and replenishment work, adjust inventory, and view purchase orders, products, and locations. | Goods-in and replenishment teams. |
| **Viewer** | Read-only access to jobs, products, inventory, locations, purchase orders, fulfilment, stock movements, analytics, and process logs. | Auditors, client service teams, and managers who should not change data. |
:::important
An **Operator** can complete every operational job type. Use **Picker**, **Packer**, or **Receiver** when a user only needs one part of the warehouse workflow.
:::
## Understand permission groups
Permissions control both page visibility and individual actions. The custom permission editor groups them into these areas:
| Permission group | What it controls |
| --- | --- |
| **Job Management** | Viewing your own or all users' jobs, and creating, assigning, claiming, releasing, completing, or deleting jobs. |
| **Job Types** | Picking, packing, receiving, putaway, replenishment, kitting, and cycle count workflows. |
| **Inventory & Locations** | Viewing, adjusting, and moving inventory; counting or approving stocktakes; and viewing or managing locations. |
| **Products & Orders** | Viewing or managing products, purchase orders, fulfilment records, and related actions. |
| **Reporting & Admin** | Analytics, exports, staff access, settings, process logs, and stock movement access. |
A page-level **View** permission does not include its **Manage**, **Adjust**, **Assign**, or **Export** actions. This is why a user may see a page but not see every button on it.
The **Create Cycle Count** control is governed by the cycle-count workflow permission (`cycle-count.*`) in **Job Types**. Generic create or manage permissions in **Job Management** do not reveal this control.
The editor shows permission codes such as `jobs.view.all`, `stocktake.count`, `stocktake.approve`, and `staff.manage`. Use the group and code together to identify the access you want to keep or add.
## Customise permissions for one user
Select **Customize role permissions** to replace the selected standard role's permission set for one user. Permissions included by the role template are marked **(template)**. Clear a template permission to remove it, or select another permission to add it.
For example, you can start with **Packer** and add `jobs.view.all` and `jobs.assign` for a packing-bench lead. You can also separate stocktake duties by giving counters `stocktake.count` without `stocktake.approve`, then keeping approval with supervisors.
Changing a user's standard role turns off the custom permission set and restores the new role template. Review and customise the permissions again before saving when the user needs an exception.
An **Interface Policy** is separate from authorization. It controls workflow options such as scanning and manual controls, but it does not grant access to pages or actions.
## Limit access by client
In a shared 3PL WMS instance, client records map child Starshipit accounts to the WMS account. A user's **Client Access** can be:
- **All clients**: No client restriction is added to the role.
- **Selected clients**: Client-aware products, inventory, orders, filter options, and supported reports are limited to the selected active clients.
Client scoping works alongside the role. A user needs both the page permission and access to the relevant client.
:::important
Client scoping is not the same as using a separate WMS instance. Shared products that are not assigned to a client and shared warehouse configuration, such as locations, may remain visible when the user's role grants access. Use separate WMS instances when clients require complete workspace isolation.
:::
Client-scoped users cannot manage WMS roles or modify and sync the shared product catalogue. This prevents a user limited to one client from changing account-wide access or shared product data.
## Assign or update a user's access
1. In WMS, go to **System > Roles & Permissions**.
2. Select **Sync Users** to add any new users from your Starshipit account. Existing assignments are preserved.
3. Find the user, open the actions menu, and select **Edit Role**.
4. Select the narrowest standard **Role** that covers the user's normal work.
5. Under **Client Access**, select **All clients** or **Selected clients**. If you choose selected clients, select at least one active client.
6. If needed, select **Customize role permissions**, then select every permission the user should keep or add and clear any template permissions they should not have.
7. Confirm the **Interface Policy** separately if the user's scanning or manual-control experience should differ from the account default.
8. Select **Save Role**.
Use **Add User Role** only when the user already has a Starshipit login and you know their Starshipit user ID. This action creates a WMS role assignment, not a new Starshipit user.
## Verify the user's access
After saving, ask the user to refresh WMS and check that:
- The sidebar shows only the pages allowed by their effective permissions.
- They can open the required workflow and complete an expected action.
- Client filters show only the clients they are allowed to use.
- Read-only users do not see create, edit, assign, adjust, or export actions that were not granted.
The WMS mobile app uses the same effective role, custom permissions, and client assignments as the web app. Mobile role preferences can further filter the job types shown in the app, but they cannot grant a job type that the WMS role does not allow.
Unified search is also permission-aware. It only includes result types whose destination pages the user can access. A missing search result can therefore indicate an access restriction rather than a missing WMS record.
## Apply least-privilege access
Use these examples as starting points:
| User | Suggested access |
| --- | --- |
| Picker working for one 3PL client | **Picker**, that client under **Selected clients**, no custom permissions. |
| Goods-in operator for several clients | **Receiver**, only those clients under **Selected clients**, no custom permissions. |
| Packing-bench lead | **Packer**, appropriate client scope, plus `jobs.view.all` and `jobs.assign` if they allocate work to others. |
| Client service or audit user | **Viewer**, only the clients they support. |
| Warehouse shift manager | **Supervisor**, appropriate client scope. Reserve **Admin** for people who manage WMS configuration and access. |
Review **Operator** assignments created by user sync. Downgrade them when the person does not need every operational job type.
## Troubleshooting missing pages or actions
| Problem | What to check |
| --- | --- |
| The user can sign in to Starshipit but has no WMS access | Select **Sync Users**, then confirm the user has an active WMS role assignment. Starshipit membership alone does not grant WMS permissions. |
| A page is missing from the sidebar | Check whether the user's effective permissions include that page's **View** permission. When **Customize role permissions** is enabled, check the complete custom set because cleared template permissions are excluded. Restricted pages are also excluded from unified search. Opening a page URL directly does not add permission to its protected data or actions. |
| The page opens, but a button or action is missing | Check the user's effective permissions for the required action, such as **Manage**, **Adjust**, **Move**, **Assign**, or **Export**. View access alone is not enough. |
| **Create Cycle Count** is missing | Add the cycle-count workflow permission (`cycle-count.*`) under **Job Types**. Generic create or manage permissions under **Job Management** do not reveal this control. |
| **Roles & Permissions** is missing | The user needs `staff.manage` and must have access to all clients. |
| A client or its data is missing | Confirm the client is active, mapped to the correct child Starshipit account, and selected in the user's **Client Access**. Also confirm the user's effective permissions allow them to view that type of data. |
| The mobile app is missing a job type | Confirm the user's effective WMS permissions include that job type, then check their mobile role preferences. Reopen the app or sign in again after an access change. |
| Search does not show a result type | Confirm the user can open the destination page. Search hides result groups for pages outside the user's permissions. |
| A submitted stocktake is waiting for approval | Confirm another user has `stocktake.approve`. Users with only `stocktake.count` can submit counts but cannot apply the variance. |
| The user still has too much access | Select **Customize role permissions** and clear the unwanted template permissions, or choose a narrower standard role. |
## Related articles
- [WMS for 3PLs: suggested setup guide](/articles/14700000000032-wms-for-3pls-suggested-setup-guide)
- [How to set up Starshipit WMS](/articles/14700000000002-how-to-set-up-starshipit-wms)
- [Set up Starshipit WMS Mobile](/articles/14700000000023-setting-up-the-mobile-app)
- [Unified search](/articles/14700000000022-unified-search)
- [WMS settings reference](/articles/14700000000031-wms-settings-reference)
---
# Run WMS alongside Starshipit
URL: https://support.starshipit.com/articles/14700000000004-run-wms-alongside-starshipit
Canonical: https://support.starshipit.com/articles/14700000000004-run-wms-alongside-starshipit
Markdown: https://support.starshipit.com/articles/14700000000004-run-wms-alongside-starshipit.md
Updated: 2026-05-07
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Run WMS alongside your existing Starshipit workflows with hybrid outbound models or headless mode for inventory tracking while keeping current processes.
**Starshipit WMS** is designed to complement, not replace, your existing Starshipit workflows. You can continue to:
* Use **Starshipit web** to process and print labels
* Use the **Starshipit Pick & Pack mobile app** and other existing pick-and-pack flows
* Use your current **shipping rules, automations and carrier setup**
While you do that, Starshipit WMS:
* Subscribes to **order events** (created, changed, deleted, shipped)
* Tracks **inventory and stock movements** for those orders
* Optionally provides full **inbound, stock management and WMS outbound** flows
This guide explains how to run **hybrid outbound workflows** and **headless setups**, where you keep your current Starshipit processes but still gain WMS visibility and control over stock.
## How Starshipit & WMS work together
Once the **Starshipit WMS integration** is enabled in your Starshipit account, the systems communicate via webhooks and APIs:
* **Starshipit** remains the system of record for:
+ Orders (created/updated/cancelled)
+ Shipments and labels
+ Courier configuration and routing rules
* **Starshipit WMS** becomes the system of record for:
+ Inventory (on hand, available, incoming, allocated)
+ Warehouse locations, putaway, replenishment
+ Stocktakes, adjustments and stock movement history
Key events sent from Starshipit to WMS:
* **order_created** – create/update order in WMS (status **PENDING**).
* **order_changed** – refresh order lines; WMS cancels old allocations/picks and resets to **PENDING** if needed.
* **order_deleted** – cancel allocations and jobs in WMS, free stock back to inventory.
* **order_shipped** – confirm shipment in WMS, write final stock movements and mark order as **SHIPPED** or **PARTIALLY_SHIPPED**.
You decide how much of the outbound process you want WMS to handle:
* Full WMS outbound (allocate, pick, pack & ship in WMS)
* Hybrid (some orders via WMS, some via existing Starshipit workflows)
* Headless (Starshipit handles outbound; WMS just mirrors orders & stock movements)
## Common hybrid models
### Model 1: Inventory & inbound in WMS, outbound in Starshipit
In this setup:
* All **inbound** stock (POs, receiving, putaway) is managed in WMS.
* WMS maintains **accurate inventory** and locations.
* Outbound orders are still picked and shipped using:
+ Starshipit web UI, or
+ Starshipit Pick & Pack / existing pick-and-pack processes
* When labels are printed in Starshipit, WMS receives **order_shipped** events and:
+ Deducts stock
+ Writes shipment stock movements
This gives you full inventory control in WMS without changing how your team currently ships orders.
### Model 2: WMS outbound for one warehouse, Starshipit outbound for others
For multi-location or multi-account setups, you can:
* Use **WMS outbound** (allocate, pick, pack) in one warehouse as a pilot.
* Keep **other warehouses** on existing Starshipit pick/pack flows.
* Use **WMS Override** in the integration to share one WMS across multiple child accounts if needed.
This lets you trial WMS outbound in a controlled environment while keeping other operations unchanged.
### Model 3: Full WMS outbound with Starshipit for labels only
In this model:
* Orders are allocated, picked and packed in WMS.
* At the end of packing, WMS calls Starshipit to create shipments and print labels.
* Starshipit sends **order_shipped** events back to WMS to finalise stock.
This is the "end state" for many customers once they are ready to move all outbound flows into WMS.
## Using WMS for inventory tracking only (headless)
If you are **not ready** to change any outbound workflows, you can still use WMS in a **headless** mode for orders.
### What headless looks like
* Enable the WMS integration and **send order events** from Starshipit.
* Manage **products**, **locations**, **inbound** and **stocktakes** in WMS.
* Keep using:
+ Starshipit UI or Mobile for picking (if used today), and
+ Starshipit for shipping and labels.
* WMS:
+ Creates/updates orders in **PENDING** state.
+ Listens for **order_shipped** events and records stock leaving the warehouse.
In other words, WMS becomes your **inventory ledger** (especially when combined with proper POs, receiving and stocktakes), while Starshipit remains your **operational shipping tool**.
## Use Starshipit Pick & Pack and web workflows with WMS
Many customers already use:
* **Starshipit Pick & Pack** to scan orders and print labels
* **Starshipit web workflows** for picking and packing
You do **not** need to stop using these when enabling WMS.
### How this works in practice
1. Orders import into Starshipit from your ecommerce/ERP as usual.
2. Starshipit sends **order_created** to WMS so the order appears on the WMS orders dashboard.
3. Your team picks and ships using Starshipit Pick & Pack or Starshipit web workflows.
4. When a label is printed, Starshipit fires **order_shipped** to WMS.
5. WMS records stock movements and marks the order as shipped in the WMS view.
Over time, you can move some or all orders to full WMS picking and packing while keeping Starshipit Pick & Pack for supported non-WMS workflows.
## Rollout strategies
Because WMS can run alongside your existing workflows, you have flexibility in rollout:
### Start with inbound only
* Use WMS for purchase orders, receiving, putaway and stocktakes.
* Leave all outbound on existing Starshipit processes.
* This gives you accurate inventory without changing anything your shipping team does today.
### Gradual outbound migration
* **Phase 1: Headless** — WMS logs orders and shipments; you ship everything via Starshipit.
* **Phase 2: WMS outbound for low-risk orders** — begin using WMS allocate/pick/pack for a small channel or SKU set.
* **Phase 3: Extend WMS outbound** — roll out to more orders and channels as the team gains confidence.
### Full WMS adoption
* All warehouses use WMS for inbound, inventory and outbound.
* Starshipit handles label creation, carrier management and shipping automation.
## Best-practice hybrid setups
* **Keep one system as order "truth".** Make all order edits in Starshipit, and let WMS follow via webhooks.
* **Use WMS as stock "truth".** Perform all receiving, stocktakes and adjustments in WMS.
* **Start simple with headless.** Enable WMS to track stock via order_shipped first, then layer on picking and packing later.
* **Segment by warehouse or channel.** Use WMS outbound for specific warehouses or brands while leaving others on existing workflows.
* **Use dashboards to reconcile.** Periodically compare Starshipit shipped orders and WMS stock movements to confirm they line up.
## FAQ
Do I have to change how my team prints labels?
No. You can keep printing labels in Starshipit exactly as you do today. As long as order events are enabled, WMS will track shipments via the **order_shipped** webhook.
Can I use WMS just for inbound and stocktakes?
Yes. Many customers start with WMS for purchase orders, receiving, putaway and stocktakes only. Outbound can remain in Starshipit until you are ready to move it.
What happens if I ship an order in Starshipit without touching it in WMS?
When you ship in Starshipit, it sends **order_shipped** to WMS. WMS will create a shipment movement based on the order lines and update inventory — even if you did not allocate or pick the order in WMS.
Will using hybrid mode cause double-shipping?
No, as long as you only ship orders in one place (Starshipit or via WMS triggering Starshipit). WMS does not create shipments on its own — it always relies on Starshipit for label creation and shipment confirmation.
---
# Troubleshoot Starshipit WMS
URL: https://support.starshipit.com/articles/14700000000047-troubleshoot-starshipit-wms
Canonical: https://support.starshipit.com/articles/14700000000047-troubleshoot-starshipit-wms
Markdown: https://support.starshipit.com/articles/14700000000047-troubleshoot-starshipit-wms.md
Updated: 2026-07-20
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Find the right next step when WMS users cannot access a page, stock does not look right, or an inbound or fulfilment workflow cannot progress.
Use this guide to identify the most likely place to investigate a WMS issue before escalating it.
## Find the right troubleshooting guide
| Issue | What to check |
| --- | --- |
| A user cannot see a page or complete an action | [Set up WMS users, roles and client access](/articles/14700000000036-wms-users-roles-permissions-client-access) |
| A setting is missing or does not behave as expected | [WMS settings reference](/articles/14700000000031-wms-settings-reference) |
| Stock quantity or availability looks wrong | [Adjust stock and investigate stock movements](/articles/14700000000020-stock-integrity-and-adjustments) |
| An order cannot be picked, packed or shipped | [Manage orders and allocation in WMS](/articles/14700000000010-starshipit-wms-orders-and-allocation) |
| A mobile workflow is failing | [Troubleshoot Starshipit WMS Mobile](/articles/14700000000038-troubleshoot-starshipit-wms-mobile) |
| An integration is not syncing as expected | [Understand WMS integrations](/articles/14700000000044-understand-wms-integrations) |
## Capture useful details before escalating
Record the WMS account, affected user, order, purchase order, product SKU or location, the time the issue occurred, and any visible error message. Include the workflow step where it stopped and whether the same issue affects other users or records.
This information makes it much faster for your WMS administrator or Starshipit Support to reproduce the problem.
---
# Set up WMS for a 3PL
URL: https://support.starshipit.com/articles/14700000000032-set-up-wms-for-a-3pl
Canonical: https://support.starshipit.com/articles/14700000000032-set-up-wms-for-a-3pl
Markdown: https://support.starshipit.com/articles/14700000000032-set-up-wms-for-a-3pl.md
Updated: 2026-08-26
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Choose a shared or separate WMS setup, map child Starshipit accounts to WMS clients, and verify that each client's orders, products and stock are scoped correctly.
Set up Starshipit WMS to fulfil orders for multiple client brands from one warehouse. You can manage clients inside one shared WMS instance or give each client a separate WMS instance.
## Choose a WMS structure
Choose your structure before connecting client accounts. Moving a client later may require you to migrate products, stock and open warehouse work.
| | Shared WMS instance | Separate WMS instances |
| --- | --- | --- |
| **Operator experience** | Work across clients in one interface | Switch instances to work for another client |
| **Client boundary** | WMS client records scope products, inventory, orders and user access | Each instance has its own products, inventory, orders, locations and users |
| **Pick runs** | Can include orders from more than one client | Stay within one client instance |
| **Warehouse layout** | Locations and zones are shared | Configure locations and zones in each instance |
| **Client access** | Limit users to selected clients, but some shared configuration may remain visible | Complete workspace isolation |
| **SKU rules** | A SKU identifies one product in the shared catalogue | The same SKU can represent different products in different instances |
| **Best for** | Central warehouse teams that share processes and need one operational view | Clients that require complete isolation or use conflicting product catalogues |
:::important
Zones organise your physical warehouse layout. They do not separate 3PL clients. In a shared instance, use **Clients** and client access assignments to keep client-owned records separate.
:::
## Before you begin
For a shared WMS instance, you need:
- A Starshipit parent account and a [child account for each client brand or source account](/articles/360001575375-set-up-a-child-account).
- Starshipit WMS enabled and initially configured on the account that will host the shared instance. See [Set up Starshipit WMS](/articles/14700000000002-how-to-set-up-starshipit-wms).
- The **Admin** role or the `settings.manage` permission in the shared WMS instance.
- The numeric Starshipit account ID for each child account. Open WMS while signed in to the child account and find the ID in the account selector at the top of the page.
- A unique SKU across the shared WMS catalogue when two client products are different. If two clients use the same SKU for different products, use separate WMS instances or change one client's SKU before importing products.
Connect each client's ecommerce stores and couriers to that client's child Starshipit account before you begin importing orders.
## Set up clients in one shared WMS instance
### Point each child account to the shared instance
Complete these steps while signed in to the child Starshipit account:
1. Open WMS.
2. Go to **System > Settings**.
3. Select **WMS Integration**.
4. Turn on **Enable WMS integration**.
5. Under **WMS instance override**, select the account that hosts the shared WMS instance.
6. Select **Save Integration Settings**.
The override tells Starshipit to send that child account's WMS order events to the shared instance. Repeat these steps for every child account that should use the shared warehouse.
### Add the client mapping
Add the mapping before the first import when you want to control the client name shown in WMS:
1. Open the shared WMS instance.
2. Go to **Setup > Clients**.
3. Enter the **Client name** your warehouse team should see.
4. Enter the child account's numeric **Source account ID**. Do not enter the shared WMS account ID.
5. Enter a **Source name** if you want the source-account badge to show a label as well as its ID. Use the child account's Starshipit name for consistency.
6. Select **Add**.
7. Confirm the new client is **Active** and the correct source account appears beside it.
The **Default** record belongs to the account hosting the shared WMS instance. Activity from that account stays with the default client. You cannot delete the default record.
If one warehouse client sends activity from several child Starshipit accounts, add each source account using the exact same **Client name**. WMS maps those source accounts to one client record.
WMS can also create the mapping automatically when the first order arrives with a valid WMS instance override. After the first import, open **Setup > Clients** and check that the generated client name and source account are correct.
### Assign user access
Client mapping controls record ownership. User access is configured separately:
1. Go to **System > Roles & Permissions**.
2. Edit the user's role.
3. Under **Client Access**, select **Selected clients**.
4. Select the clients that user can work with.
5. Save the role, then ask the user to refresh WMS.
See [Set up WMS users, roles and client access](/articles/14700000000036-starshipit-wms-users-roles-permissions-client-access) for role and permission details.
:::important
Client-scoped access is not complete workspace isolation. Shared locations and some account-wide configuration may remain visible when the user's role permits it. Use separate WMS instances when a client must not see any shared warehouse configuration.
:::
### Configure the shared warehouse
Create locations and zones for the physical warehouse, not for each client. Then import or create products and stock for each mapped client.
Use clear location names when areas are physically dedicated to a client. See [Set up warehouse locations and work areas](/articles/14700000000033-starshipit-wms-locations-and-warehouse-setup).
## Set up separate WMS instances
Use a separate instance when clients need complete isolation or when the same SKU represents different products for different clients.
For each child account:
1. Open WMS while signed in to that child account.
2. Go to **System > Settings > WMS Integration**.
3. Turn on **Enable WMS integration**.
4. Set **WMS instance override** to **No override (use current account)**.
5. Select **Save Integration Settings**.
6. Complete the initial WMS setup for that account.
7. Configure its locations, products, users and workflow settings.
Each instance has its own default client record and operates independently. Orders from different instances cannot be combined into one pick run.
## Verify the client setup
Import one order from each child account before going live. In the shared WMS instance, confirm that:
- **Setup > Clients** shows the expected source account under the correct active client.
- The order appears under the correct client in **Starshipit Orders**.
- Imported products belong to the expected client, or are deliberately shared.
- Inventory and reports show the correct client when you apply a client filter.
- A user with **Selected clients** access can see the expected client records and cannot see another client's client-aware records.
- Picking and shipping the test order writes the result back to the correct child Starshipit account.
## Troubleshoot client setup
| Problem | What to check |
| --- | --- |
| **Source account ID is required** | Enter the numeric child Starshipit account ID. Do not enter an account name or the shared WMS account ID. |
| **Source account is not connected** | Open WMS while signed in to the child account, then retry the mapping from the shared instance. |
| An order appears under the default client | Confirm the child account has the shared account selected under **WMS instance override**, then check its source account mapping under **Setup > Clients**. |
| WMS created an unexpected client automatically | Check which child account sent the first order and confirm its account name and instance override. Contact Starshipit support before unmapping a client that already has warehouse history. |
| A child user can see more than expected | Check both the user's role permissions and **Client Access**. Use a separate WMS instance if shared configuration must also be hidden. |
| A product import reports duplicate SKU ownership | In a shared instance, one SKU identifies one catalogue product. Confirm whether the product should be shared, change one client's SKU, or use separate instances. |
## FAQ
Can a client sign in and see only their own WMS records?
Yes. In a shared instance, assign the user a suitable role and select only that client under **Client Access**. Some shared warehouse configuration may still be visible. Use a separate WMS instance for complete isolation.
Can two clients use the same SKU?
Yes, when the SKU refers to one deliberately shared product. A shared WMS catalogue cannot hold two different products with the same SKU. Use different SKUs or separate WMS instances when the products are different.
Do I need to create a client before importing its first order?
No. WMS can create a client mapping when the first order arrives with a valid WMS instance override. Create it manually when you want to choose the client name and verify the mapping before importing orders.
What is the difference between a client and a zone?
A client identifies who owns products, stock, orders and client-aware access. A zone groups physical warehouse locations. Use zones to organise warehouse work, not as the client ownership boundary.
---
# Set up BigCommerce with Starshipit WMS
URL: https://support.starshipit.com/articles/14700000000050-set-up-bigcommerce-with-starshipit-wms
Canonical: https://support.starshipit.com/articles/14700000000050-set-up-bigcommerce-with-starshipit-wms
Markdown: https://support.starshipit.com/articles/14700000000050-set-up-bigcommerce-with-starshipit-wms.md
Updated: 2026-08-03
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Import BigCommerce products into Starshipit WMS and configure location-aware inventory writeback for each connected store.
Connect BigCommerce through Starshipit, import BigCommerce products into Starshipit WMS, and keep each connected store's inventory aligned with WMS.
## Before you begin
You need:
* A BigCommerce store connected to the current Starshipit account or an eligible source account.
* Permission to manage products and commerce settings in WMS.
* Unique, non-empty SKUs on the BigCommerce variants you want to manage.
* An active BigCommerce inventory location for each writeback target.
If BigCommerce is not connected yet, [connect BigCommerce to Starshipit](/articles/204502815-connect-bigcommerce-to-starshipit) first.
:::important
Decide whether WMS or another system owns BigCommerce inventory before enabling writeback. A manual WMS sync sends the current WMS on-hand quantity to BigCommerce.
:::
## Import products from BigCommerce
1. Go to **Products** in WMS.
2. Open the actions menu and select **Sync from BigCommerce**.
3. Choose the product fields to import.
4. Optionally enter SKU filters to limit the import.
5. Select **Start Sync**.
6. Review the result, then open a product and confirm its BigCommerce source and SKU.
Products are matched by SKU. The import creates the BigCommerce product or variant link used for inventory writeback.
## Configure BigCommerce inventory writeback
1. Go to **System > Settings > Inventory Writeback**.
2. Find **BigCommerce Inventory Sync**.
3. Review the default store and any linked source stores.
4. Select a **Writeback Location** for each store WMS should update.
5. Turn on **Auto Writeback** for each configured store.
The default row is used when a product is not assigned to a specific source store. A linked row uses that product's source Starshipit account and BigCommerce store.
Only products connected to BigCommerce and assigned to a target with an active location can be written back.
## Understand automatic writeback
After a supported receipt, pick, shipment, manual adjustment or stocktake variance completes, WMS queues the BigCommerce update in the background. The warehouse transaction does not wait for BigCommerce and is not rolled back if the update fails.
You can disable BigCommerce writeback for an individual product when WMS should not manage that product's store inventory.
## Run a manual inventory sync
1. Go to **Inventory**.
2. Select the BigCommerce-linked products you want to update.
3. Select **Sync to BigCommerce**.
4. Review the products and current WMS quantities.
5. Select **Sync to BigCommerce** to queue the writeback.
6. Go to **System > Process Logs** and confirm the updates completed.
Products without an enabled BigCommerce link and writeback target are skipped.
## Verify the integration
1. Import a test product from BigCommerce.
2. Select its store's writeback location.
3. Enable **Auto Writeback** for that store.
4. Complete a controlled stock adjustment in WMS.
5. Confirm the quantity changed at the selected BigCommerce location.
6. Check **System > Process Logs** for the BigCommerce result.
## Troubleshooting
| Problem | What to check |
| --- | --- |
| BigCommerce does not appear in WMS settings | Confirm the integration is connected to the current or eligible source Starshipit account, then refresh the settings page. |
| No stores are listed | Import products from BigCommerce or confirm the current Starshipit account has a BigCommerce connection. |
| No locations are available | Confirm the BigCommerce store has an active inventory location, then refresh **BigCommerce Inventory Sync**. |
| **Auto Writeback** is unavailable | Select a **Writeback Location** for the target first. |
| A product is skipped | Confirm the product was imported or linked to BigCommerce and its provider writeback has not been disabled. |
| A quantity does not change | Check the product's source store, selected location and **System > Process Logs** for the returned BigCommerce error. |
If the problem continues, contact [Starshipit support](https://help.starshipit.com) with the WMS account, BigCommerce store, SKU, selected location and approximate time of the sync.
## Related articles
* [Understand WMS integrations](/articles/14700000000044-understand-wms-integrations)
* [Configure WMS products and inventory](/articles/14700000000006-starshipit-wms-products-and-inventory-configuration)
* [Maintain stock accuracy and make adjustments](/articles/14700000000020-adjust-stock-and-investigate-stock-movements)
---
# Configure WMS products and inventory
URL: https://support.starshipit.com/articles/14700000000006-configure-wms-products-and-inventory
Canonical: https://support.starshipit.com/articles/14700000000006-configure-wms-products-and-inventory
Markdown: https://support.starshipit.com/articles/14700000000006-configure-wms-products-and-inventory.md
Updated: 2026-09-11
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Configure how products behave in WMS including bundles, units of measure, tracking types (batch/serial), and allocation strategies (FIFO, LIFO, FEFO).
The **Products** section in Starshipit WMS is where you define how each SKU behaves in the warehouse. This configuration controls how stock is received, tracked, allocated and picked.
When you first set up Starshipit WMS, you will typically:
* Sync products from your existing Starshipit account or connected commerce platforms
* Review and adjust product settings for bundles, units of measure and tracking
* Choose an allocation strategy per product
Getting product configuration right up front helps avoid receiving errors, allocation failures and unnecessary manual work later.
## Syncing products from Starshipit
Starshipit WMS connects to your Starshipit account to pull in product data so you do not have to recreate your catalogue from scratch.
1. Go to the **Products** section in Starshipit WMS.
2. Use the **Sync products** action to import products from Starshipit.
3. Once the sync is complete, you will see your SKUs listed with their basic details. From here you can configure WMS-specific options such as bundles, tracking types and allocation rules.
After the initial sync, products can be kept up to date by running further syncs or by editing individual records directly in WMS.
The products list brings together product images, tracking types, bundle settings, inventory and allocation rules so you can spot records that need review.
### Importing multiple products at once
When importing products from a dialog, you can enter **comma-separated SKUs** to import multiple specific products at once, rather than importing one at a time.
### Importing products from commerce platforms
If you have connected commerce platforms, you can import products directly from Shopify, BigCommerce, WooCommerce, Cin7 Omni and Magento 2. Choose the connected source, start the import, then review the product records in WMS.
Commerce imports run in the background as process runs, so larger catalogues can keep processing without locking the rest of WMS. Use **System > Process Logs** to confirm whether an import completed or needs attention.
When syncing from Shopify, the system can also capture **HS codes** and **country of origin** data from the Shopify product record.
The Unleashed WMS integration does not provide a direct product-import action. Create or import products into WMS first and make sure each WMS SKU matches the Unleashed product code. See [Understand WMS integrations](/articles/14700000000044-understand-wms-integrations) for the setup guide for each provider.
## Creating, editing, and cloning products
You can manage product records directly in WMS in addition to syncing from Starshipit:
* **Create** new products when you need SKUs that do not exist in Starshipit yet.
* **Edit** existing product details (for example, tracking type or allocation strategy).
* **Clone** a product to duplicate its configuration and reduce setup time. After cloning, confirm the **SKU** is unique before saving.
The Products list also supports **barcode-based lookups**. If a scan returns no results, confirm the barcode is stored on the product record and that your scanner input is mapped correctly.
Use **Delete** only for a product with no inventory or stock-movement history. When history prevents deletion, WMS offers **Archive** instead. Archiving keeps the history but hides the product from active inventory and product-selection workflows. Use the **Archived** filter to switch between Active, Archived, and All products.
## Product records and core fields
Each product in WMS has a set of core fields used across inbound, stock management and outbound flows.
* **SKU** – the unique code for the product (must match your ecommerce/Starshipit SKU).
* **Name** – human-readable product name.
* **Barcode** – used for scanning during picking, packing, stocktake, and quick lookups on product and inventory screens.
* **Client** – optional client ownership or scope, useful for 3PLs and shared warehouse operations.
* **Price** – defaults to `0` if no price is supplied.
* **On hand / Available / Committed / Incoming** – inventory metrics shown in the inventory dashboard. **Committed** represents stock reserved for pending orders. **Available** is the quantity that can still be allocated (On hand minus Committed).
* **Bundle configuration** – whether the SKU is a bundle and how it should be fulfilled.
* **Unit of measure setup** – parent/child relationships for cartons vs eaches, etc.
* **Tracking type** – Standard (none), Batch or Serial.
* **Allocation strategy** – FIFO, LIFO, FEFO or LEFO.
* **Image** – product images can be loaded from any domain, which helps when hosting images outside Starshipit.
You can edit these settings from the product detail page in WMS. Changes affect how future stock movements and orders behave, so it is best to review them carefully during onboarding.
## Bundle products
Starshipit WMS supports bundle or kit SKUs made up of other SKUs. These are configured as **bundle products** and can be handled in two ways:
### Exploding bundles
An **exploding bundle** is a bundle SKU that breaks down into its component SKUs when an order is processed. The WMS does not pick the bundle SKU directly. Instead, it:
* Allocates and picks the *individual component SKUs*
* Tracks inventory at the component level
* Treats the bundle as a logical grouping for ordering and reporting
This is useful when you never hold a pre-built kit in stock but always assemble it from individual components when fulfilling an order.
### Require stock bundles (pre-kitted)
A bundle set to **Require stock** behaves like its own physical item. In this case:
* The bundle SKU has its *own inventory* that must be on hand to fulfil orders
* When stock is not available, WMS can create a **kitting job** prompting staff to assemble bundles from components
* Once assembled, the on hand quantity for the bundle SKU is increased
Kitting jobs support **Pending** and **Assigned** statuses, allow assignment management, and can auto-allocate components to speed up kitting workflows.
This mode is ideal when you keep pre-built packs on the shelf and want to ensure they are either available or explicitly assembled as a separate process.
WMS validates bundle setup during order and release workflows. If a bundle is missing required component information or stock rules, the error is surfaced so you can correct the product before warehouse work begins.
### Choosing the right bundle mode
* Use **exploding bundles** when you do not store pre-made kits and always pick component items.
* Use **require stock** when you store finished kits and want kitting to be a separate, trackable activity.
Quick comparison:
| | Exploding bundles | Require stock bundles |
| --- | --- | --- |
| **How it works** | Breaks down into component SKUs when an order is processed | Bundle SKU has its own inventory that must be on hand |
| **Inventory tracking** | At component level | At bundle level |
| **Picking** | WMS picks individual component SKUs | WMS picks the bundle SKU directly |
| **Kitting** | Components assembled at fulfilment | Pre-built kits stored on shelf; kitting jobs create bundle stock |
| **Best for** | Never store pre-made kits, always pick components | Keep pre-built packs on shelf and track as separate inventory |
## Parent/child SKUs and units of measure
WMS allows you to link products in **parent/child relationships** to represent different units of measure for the same item. For example:
* A **case of 24** could be the child
* A **single unit** could be the parent (what the inventory is ultimately tracked in)
Each child SKU stores:
* Its own SKU and description
* A conversion factor (for example, 24 eaches per case)
Inventory is tracked at the child SKU level, while transactions can be recorded in any defined unit. This is useful when:
* You purchase in cartons or pallets
* You sell in smaller units (e.g. eaches or inner packs)
* You want consistent visibility of the same underlying stock
## Tracking types
Each product can be configured with one of three tracking types. This controls what information is required during receiving, stocktake and picking. Choose the tracking type before adding stock: once the SKU has stock or stock-movement history, its tracking type cannot be changed, even after stock is depleted.
| Tracking type | Description |
| --- | --- |
| **Standard** | Inventory is tracked purely by quantity. The system does not require or store any batch or serial identifiers. Use this for products where it is enough to know how many you have, not exactly which units. |
| **Batch** | Records stock by lot or batch. Common examples include food and beverage with expiry dates, cosmetics and pharmaceuticals, and manufactured goods requiring traceability. WMS will prompt for a batch/lot number during receiving, optionally capture an expiry date, and show stock at the level of product + batch + location. |
| **Serial** | Each individual unit is uniquely identified by a serial number. WMS will require one serial number per unit during receiving, prompt for serials during picking/packing, and track movements per serial for a detailed audit trail. |
To check labelled batch, expiry and serial details against allocated stock on a handheld device, see [Validate batches and expiry dates with GS1 barcodes in WMS Mobile](/articles/14700000000055-validate-batches-and-expiry-dates-with-gs1-barcodes-in-wms-mobile).
## Allocation strategies
Allocation strategies define which specific stock is reserved first when orders are released. You can configure this per product to match your operational and compliance needs.
| Strategy | Description |
| --- | --- |
| **FIFO** (First In, First Out) | Allocates the oldest stock first, based on when it entered the warehouse. This is typically the default setting and suits most non-perishable products. |
| **LIFO** (Last In, First Out) | Allocates the newest stock first. Useful in specific operational scenarios where newer stock is more accessible or preferred. |
| **FEFO** (First Expiry, First Out) | Allocates stock with the earliest expiry date first. Commonly used with batch-tracked products to reduce write-offs due to expired stock. |
| **LEFO** (Last Expiry, First Out) | Allocates stock with the latest expiry date first. A specialised option for when you intentionally want to ship the longest-dated stock first. |
The chosen allocation strategy is used when orders are released. WMS looks at the available stock (including batch and expiry where applicable) and reserves the correct units according to that rule.
## Commerce product and inventory sync
If you have connected commerce platforms to your Starshipit account, the WMS product sync dialog shows the available stores or sources as selectable options. Make sure you select the correct source before starting a sync.
The same dialog includes inventory sync controls:
* **Enable inventory sync back to the connected platform** – turns on inventory writeback.
* **Run a hard sync** – forces a full inventory sync when needed.
* **Set inventory values** – lets you push specific inventory values during the sync.
These options now align with the underlying API behavior, so the dialog reflects what the sync will actually do.
If inventory updates fail, confirm the sync toggle is enabled, the product has the right platform mapping, and the connected account allows inventory updates.
## Product lookup and management
### Looking up products by barcode
On both the **Inventory** and **Products** pages, you can look up products by scanning or entering a barcode. This supplements the existing SKU and name search and is useful for quickly finding a product on the warehouse floor.
### Printing product barcode labels
Open a product's row actions and select **Print barcode**, or select up to 100 products and choose **Print barcodes**. Preview the labels and choose sheet, 101 x 48 mm, 57 x 32 mm, or 100 x 50 mm layout before printing. WMS renders a valid 13-digit EAN-13 barcode as EAN-13 and uses Code 128 for other supported values. The selected layout is remembered in that browser.
### Cloning a product
A **Clone** action button is available on the products list. This creates a copy of an existing product with all its settings, allowing faster creation of similar products. You can then edit the cloned product to change the SKU, name and any other fields that differ.
### Reviewing product audit history
Open an existing product for editing, then select the **Audit** tab to review when it was created and last updated, its creation source, and product-related changes captured in the WMS process log. Each recorded event includes its time, source and operator.
The audit tab shows changes that WMS recorded as product-specific process-log events. It is not a complete field-by-field history for changes made before those events were recorded.
### Bulk editing products
You can select multiple products and open a **Bulk Edit** dialog to update fields across all selected products at once. This supports:
* **Country of Origin**
* **Allocation Rule** (FIFO, LIFO, FEFO, LEFO, or Specific Lot)
* **Client** or client ownership, where client scoping is enabled
If you open Bulk Edit but do not change any editable fields, WMS returns **Nothing to update**.
Use the default no-client product setting if most products should remain unassigned until a client is known. This helps 3PL teams prevent accidental cross-client assignment during bulk imports.
## CSV stock on hand report
An **Export SOH Report** action on the inventory dashboard generates a CSV file of current stock-on-hand levels across all products and locations. This is useful for reporting, reconciliation with finance systems, and sharing stock data with external partners.
## Best-practice configuration
* **Decide tracking rules per product family.**
For example, all perishable items use Batch + FEFO, all electronics use Serial + FIFO, and accessories use Standard + FIFO.
* **Keep bundles simple where possible.**
Use exploding bundles when you never hold pre-kitted stock. Use require-stock bundles when you do and want kitting to be a planned activity.
* **Align units of measure with purchasing and selling.**
Set up parent/child SKUs so receiving, storage and selling match how you operate day to day.
* **Test with a small subset first.**
Configure a small group of high-volume SKUs, run through a full inbound and outbound cycle, and only then roll out to the full catalogue.
## FAQ
Do I need to use bundles?
No. Bundles are optional. If you do not sell kits or sets, you can leave all products as standard SKUs.
Can I change a product from Standard to Batch or Serial later?
Only before the SKU has had stock. WMS blocks tracking-type changes when the SKU has stock on hand or any stock-movement history, even after its stock has been depleted. Choose Standard, Batch or Serial before receiving or importing starting stock. If an existing stocked SKU has the wrong tracking type, contact support to plan the correction.
What happens if I choose the wrong allocation strategy?
Orders will still allocate, but not in the way you expect (for example, newer stock may be used before older stock). If you update the allocation strategy, it will apply to future allocations. Existing allocations are not automatically reallocated.
How do bundles affect inventory figures?
For **exploding bundles**, stock is tracked at the component level and bundle availability is derived from components. For **require stock** bundles, the bundle SKU has its own on hand quantity and behaves like a normal product.
Can parent and child SKUs share the same barcode?
It is recommended to use distinct barcodes for each unit of measure to avoid confusion during scanning. If you must share a barcode, ensure your processes clearly distinguish which unit is being picked or received.
Can I import products from commerce platforms?
Yes. You can import directly from Shopify, BigCommerce, WooCommerce, Cin7 Omni and Magento 2. Shopify imports can also include HS codes and country of origin data. Unleashed uses matching WMS SKUs for purchase-order import and inventory writeback instead of a direct product import.
Can I look up a product by barcode?
Yes. On both the Inventory and Products pages, you can scan or enter a barcode to find a product. This works alongside the existing SKU and name search.
---
# WMS settings reference
URL: https://support.starshipit.com/articles/14700000000031-wms-settings-reference
Canonical: https://support.starshipit.com/articles/14700000000031-wms-settings-reference
Markdown: https://support.starshipit.com/articles/14700000000031-wms-settings-reference.md
Updated: 2026-09-08
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Learn what each of the 22 WMS Settings tabs controls across operations, orders, inventory, notifications, account, apps, and system.
Use this reference to understand how each setting changes your Starshipit WMS workflows.
**Path:** **System > Settings**
The Settings page groups 22 tabs into six navigation sections:
| Section | Tabs |
| --- | --- |
| **Operations** | Picking, Packing, Printing, Receiving, Putaway, Replenishment, Job Interface |
| **Orders & Jobs** | Orders, Order Routing, Jobs, Allocation |
| **Products & Inventory** | Products, Product Syncs, Inventory Writeback, Direct Integrations |
| **Notifications** | Email Notifications, Webhooks |
| **Account & Apps** | Starshipit Account, WMS Integration, Apps, Appearance |
| **System** | System |
:::note
The tabs you can see depend on your permissions. **Products**, **Product Syncs**, **Inventory Writeback**, and **Direct Integrations** require permission to manage both settings and products. Integration-specific controls only appear when the matching provider is available on your Starshipit account.
:::
Can't find a setting? Use the **Search settings** box at the top of the page, or open **Search** from the left navigation and enter the setting name.
## Operations
### Picking
| Setting or control | What it does |
| --- | --- |
| **Tote Picking** | Lets workers pick a batch directly into totes, with one tote per order. Completing the pick creates one pack job for each tote. |
| **Require Pick Job ID on Create** | Requires the user to enter a Pick Job ID instead of letting WMS generate one. |
| **Hide Packing Bench on Create** | Hides the packing-bench selector when creating batch pick jobs so they follow the standard picking workflow. |
| **Auto-download Batch Order Packing Slips** | Downloads one PDF containing a bin-aware packing slip for each order after a batch pick is created. |
### Packing
| Setting or control | What it does |
| --- | --- |
| **Allow Partial Packing** | Lets packers print labels for quantities already packed. Turn it off to require the full packable quantity before printing. |
| **Dedicated Ship Process** | Separates packing from shipping. Packers finish packing first, then labels are printed from the shipping dashboard. |
| **Allow Ship Jobs on Mobile** | Lets mobile workers view and complete dedicated ship jobs. Turn it off to restrict shipping to the browser WMS. |
| **Show Bundle Names in Packing** | Shows exploding bundle parent rows so packers can see which bundle each component belongs to. |
| **Prevent Carrier/Service Changes in Packing** | Keeps the carrier and service selected before packing locked for packers. |
| **Disable Auto Label Print** | Requires packers to select **Print Label** after all items are packed. Leave it off to print automatically when packing completes. |
### Printing
| Setting or control | What it does |
| --- | --- |
| **Open labels in browser print dialog** | Opens shipping labels in the browser print dialog. Leave this off when your workflow downloads the PDF or lets the Desktop App handle the label. This setting does not choose a Print Client machine or physical printer. See [Understand how Starshipit printing works](/articles/90200000000155-understand-how-starshipit-printing-works). |
| **Delay printing during packing** | Sets the account-wide packing countdown before labels print. Turn it off to print as soon as an order is ready. |
| **Auto-save carrier on print** | Saves carrier or service changes to Starshipit before printing. Turn it off to sync only changes that a user explicitly saves. |
| **Show Bin Locations on Packing Summary** | Includes pick bin locations on combined packing summary PDFs when allocation snapshots are available. |
### Receiving
| Setting or control | What it does |
| --- | --- |
| **Over-Receiving Tolerance** | Sets the maximum percentage above each ordered purchase-order line that workers can receive. `0%` prevents over-receiving. A blank value may represent an unlimited legacy setting until a finite percentage is saved. |
| **Under-Receiving Tolerance** | Sets the maximum percentage shortage allowed when deliberately marking a purchase order complete. Leave it blank to allow completion without a shortage limit. |
| **Enable Cartons Received** | Shows the optional cartons-received field during purchase-order receiving and includes the value in receipt reporting. |
| **Container Numbering** | Sets the next sequential `CON-` barcode used when containers are created in bulk. |
### Putaway
| Setting or control | What it does |
| --- | --- |
| **Enforce Putaway Locations** | Reserves destination capacity and requires workers to gather stock onto equipment, then place it at WMS-assigned destinations in route order. Applies to new putaway jobs only. |
| **Aggregate Putaway Into Existing Jobs** | Adds newly staged purchase order stock to an existing open putaway job at the same staging location. Turn it off to create separate putaway work. |
### Replenishment
| Setting or control | What it does |
| --- | --- |
| **Create replenishment work** | Chooses between creating work only when picking requires stock or automatically reviewing aggregate pending-order demand after order imports. |
| **Replenish destination to** | Targets the configured minimum or maximum after demand. WMS still caps work by destination capacity and available bulk stock. |
### Job Interface
These controls apply across supported web and mobile job interfaces. Users without an assigned interface policy inherit the account default.
| Setting or control | What it does |
| --- | --- |
| **Interface Policy** | Selects the account default or a staff policy to edit. You can create, rename, and delete policies. A policy must be unassigned before it can be deleted. |
| **Common Workflows** | Applies a preset to the selected policy. Choose **Barcode warehouse**, **Strict scanning**, **Assisted scanning**, or **Manual warehouse**, then adjust individual controls if needed. |
| **Barcode Scanning** | Shows barcode scanner and camera input in supported job interfaces. Turning this off also disables scan history and location verification, and keeps manual location confirmation and item selection available. |
| **Show Scan History on Web** | Shows recent scans and scan errors in supported web job interfaces. Mobile job screens do not show scan-history panels. |
| **Allow Typed Barcode Entry** | Lets workers type or paste values into supported scanner controls. Turn it off for managed scan-only workflows. |
| **Skip Initial Location Selection** | Starts supported mobile flows, including standard and tote picking, at the first actionable item. Enabling it turns off location verification because the workflow does not begin with a selected location. |
| **Require Location Verification** | Requires workers to verify job locations before confirmation in supported flows. Barcode scanning must also be enabled. |
| **Allow Manual Location Confirmation** | Shows manual actions such as **I am here** or **Confirm Location Without Scan**. Turn it off to require barcode input for location verification. |
| **Allow Manual Item Selection** | Lets workers select job items from lists or cards without scanning. Turn it off to require barcode input where supported. |
| **Allow Manual Quantity Entry** | Shows direct quantity input and plus or minus controls where a job line supports quantity adjustment. |
| **Allow Partial/Manual Completion** | Lets workers complete or confirm a line before its expected quantity has been scanned or entered. |
| **Allow Pick All / Receive All Shortcuts** | Shows full-quantity shortcuts such as **Pick All**, **Receive All**, or **Complete All** where supported. |
:::caution
Before enforcing scan-only work, make sure every required location and product has a readable barcode. Workers can be blocked when manual location confirmation or item selection is unavailable.
:::
## Orders & Jobs
### Orders
| Setting or control | What it does |
| --- | --- |
| **Order Hold Reasons** | Controls the reasons operators can choose when placing an order on hold. Add a code and label, choose the highlight colour shown on held-order rows and badges, set its display order, and make it active or inactive. Built-in reason codes cannot be changed or removed. |
| **Keep shipped stock deducted when orders are archived or deleted** | Off by default. Turn it on to keep previously shipped stock deducted when an order is archived or deleted. Orders, jobs and allocations are still cleaned up. |
### Order Routing
| Setting or control | What it does |
| --- | --- |
| **Enable routed-order management actions** | Shows actions for rejecting pending routed orders or returning released orders to the parent pool from Starshipit Orders. |
| **Enable automatic order routing** | Lets WMS assign eligible pending orders to the best configured child store. |
| **Priority** | Ranks stores to set the routing preference order. |
| **Included** | Controls whether a store participates in routing. |
| **Auto-route** | Controls whether an included store can receive automatically routed orders. |
| **Temporarily unavailable** | Temporarily excludes an included store without removing its routing configuration. |
### Jobs
| Setting or control | What it does |
| --- | --- |
| **Job Pause Reasons** | Controls the active reason codes and labels workers can choose when pausing an in-progress job. |
### Allocation
| Setting or control | What it does |
| --- | --- |
| **Kitting allocation source priority** | Chooses whether kitting jobs reserve component stock from **Pick face first** or **Bulk storage first**. |
## Products & Inventory
### Products
| Setting or control | What it does |
| --- | --- |
| **Default allocation rule** | Sets the default for products created or imported without an allocation rule: **FIFO**, **LIFO**, **FEFO**, **LEFO**, or **Specific Lot**. A product can override the default. |
| **Default new products to no client** | Leaves manually created products without a client assignment. Imports can still assign a client from their source account or import data. |
| **Restocking lead time** | Sets the account-wide lead time used by forecasts when a product has no lead-time override. |
| **Minimum daily burn rate** | Hides products whose calculated daily consumption falls below this account-wide floor. |
| **Sales history (days)** | Sets how many days of product sales history WMS uses for restocking burn-rate forecasts. |
| **Stock adjustment reasons** | Controls the reason list warehouse users can select when recording manual stock adjustments. |
### Product Syncs
| Setting or control | What it does |
| --- | --- |
| **Starshipit inbound sync** | Imports product fields and SKU filters from Starshipit into WMS. Use **Configure** to choose and run the import. |
| **Daily import** | Runs the Starshipit-to-WMS product import each day. |
| **Starshipit outbound sync** | Exports WMS product data to Starshipit when you select **Run**. |
| **Daily export** | Runs the WMS-to-Starshipit product export each day. |
| **Shopify Daily product import** | Chooses which connected or source Shopify stores import products into WMS each day. |
| **Cin7 Omni Product Sync** | Use **Configure** for a manual import or turn on **Daily product import** for a full nightly sync. An active sync causes that night's run to be skipped. |
### Inventory Writeback
Writeback controls appear for supported providers connected to the Starshipit account. Choose the relevant setup guide in [Understand WMS integrations](/articles/14700000000044-understand-wms-integrations).
| Provider | Settings and behavior |
| --- | --- |
| **[Shopify](/articles/14700000000018-set-up-shopify-with-starshipit-wms)** | Choose a writeback location and enable automatic writeback per store. **Location buckets** can map WMS quarantine and quality control stock to Shopify quality control inventory, and damaged returns to damaged inventory. **Exploding bundles** can [set Shopify bundle availability from WMS component stock and open order demand](/articles/14700000000048-sync-exploding-bundle-availability-to-shopify), independently of automatic writeback. |
| **[BigCommerce](/articles/14700000000050-set-up-bigcommerce-with-starshipit-wms)** | Choose a writeback location and enable automatic inventory writeback per store. Only linked products with a selected location can be updated. |
| **[Magento 2](/articles/14700000000052-set-up-adobe-commerce-magento-2-with-starshipit-wms)** | Choose a writeback location and enable automatic inventory writeback per store. Only linked products with a selected location can be updated. |
| **[Cin7 Omni](/articles/14700000000053-set-up-cin7-omni-with-starshipit-wms)** | Choose a writeback branch and enable automatic writeback for connected products. |
| **[Unleashed](/articles/14700000000054-set-up-unleashed-with-starshipit-wms)** | Enter the destination warehouse code and enable automatic writeback. WMS uses each SKU as the Unleashed product code. |
| **[WooCommerce](/articles/14700000000051-set-up-woocommerce-with-starshipit-wms)** | Enables automatic inventory writeback for connected WooCommerce products. |
| **[Etsy](/articles/14700000000057-set-up-etsy-with-starshipit-wms)** | Enables automatic inventory writeback for connected Etsy variants. Etsy accepts on-hand quantities from `0` to `999`. |
| **[MYOB Acumatica](/articles/14700000000056-set-up-myob-acumatica-with-starshipit-wms)** | Choose an active Acumatica warehouse and turn on **Enable reconciliation**. Manual reconciliation queues the current WMS on-hand quantity for linked products; automatic sales movements are excluded. |
### Direct Integrations
The Direct Integrations tab contains the direct WMS connection for Cin7 Core and the WMS inventory-reconciliation settings for NetSuite.
#### Cin7 Core
The Cin7 Core connection is separate from the standard Cin7 Core order integration configured in Starshipit.
| Setting or control | What it does |
| --- | --- |
| **Core account ID** | Identifies the Cin7 Core account connected directly to this WMS account. |
| **Application key** | Authenticates WMS API requests to Cin7 Core. Saved credentials are not returned to the browser. |
| **Webhook bearer secret** | Authenticates incoming Cin7 Core webhooks. |
| **Test connection** | Saves changed credentials when needed, tests the connection, and loads active Cin7 Core warehouses. |
| **Cin7 Core warehouse** | Maps the WMS account to one Cin7 Core warehouse. WMS locations below the warehouse level are not copied to Cin7 Core. |
| **WMS reconciliation location** | Optionally receives Core stock that has no bin. Choose a visible Staging dock, Quarantine or Overflow location without a Core bin link. Stock with a Core bin still needs its own mapping. |
| **Enable Cin7 Core sync** | Accepts product, stock, and Advanced Purchase changes from Cin7 Core. |
| **Enable Cin7 Core writeback** | Sends Advanced Purchase receipts, adjustments, stocktake and cycle-count corrections, and movements between linked bins to Core. Sync must also be enabled. |
| **Enable outbound Pick/Pack writeback** | Separately enables Pick/Pack before label printing for eligible full Simple Sales with one package and up to 20 products. Starshipit handles Ship and tracking. |
| **Import locations from Cin7 Core** | Opens the location import to create Core bin links before importing stock. |
| **Register webhooks** | Creates the product, stock, and Advanced Purchase webhooks in Cin7 Core after the integration is enabled. |
| **Import products** | Queues the initial Cin7 Core product catalogue import into WMS. |
| **Apply opening stock** | Applies whole-unit opening balances to linked bins, or the reconciliation location for unbinned stock, after product and location imports. Conflicting existing stock requires review. |
#### NetSuite Inventory
NetSuite inventory reconciliation uses the NetSuite connection and token credentials already managed in Starshipit. See [Set up NetSuite with Starshipit WMS](/articles/14700000000058-set-up-netsuite-with-starshipit-wms) for the complete setup and verification workflow.
| Setting or control | What it does |
| --- | --- |
| **Verify connection** | Confirms WMS can read NetSuite inventory products through the connected Starshipit account and suggests location IDs found in the returned data. |
| **NetSuite location ID** | Maps the WMS account to one NetSuite inventory location. |
| **Location name** | Stores a display name for the mapped location in WMS. |
| **Subsidiary ID** | Identifies the optional NetSuite subsidiary used for inventory adjustments. |
| **Inventory adjustment account ID** | Identifies the required NetSuite account used for inventory-adjustment transactions. |
| **Enable integration** | Enables product linking and selected-product reconciliation. |
| **Automatic writeback** | Queues reconciliation after supported manual inventory adjustments and stocktake corrections. |
| **Find exact SKU matches** | Finds eligible untracked WMS products with one unique exact NetSuite SKU match. |
## Notifications
### Email Notifications
| Setting or control | What it does |
| --- | --- |
| **Enable WMS email notifications** | Enables operational emails for the selected events. |
| **Recipient emails** | Sets one or more recipients. Separate addresses with new lines or commas. |
| **Low stock alerts** | Sends an email when projected days of stock cover falls below the product's restock lead time. |
| **Stock received emails** | Sends a summary after purchase order receiving completes. |
### Webhooks
Webhooks send best-effort JSON payloads to an external HTTPS endpoint. WMS signs each payload with HMAC SHA-256 in the `X-Starshipit-WMS-Signature` header and never sends the secret itself.
| Setting or control | What it does |
| --- | --- |
| **Enable webhooks** | Sends the selected WMS events to the configured endpoint. |
| **Webhook URL** | Sets the HTTPS endpoint that receives event payloads. |
| **Webhook secret** | Sets the shared secret used to sign payloads. |
| **Low stock alerts** | Emits when a product enters urgent restocking status. |
| **Stock received** | Emits when purchase order receiving records stock movements. |
| **Inventory changed** | Emits when WMS records a stock movement. |
| **Purchase order lifecycle** | Emits when a purchase order is created, updated, changes status, or is deleted. |
| **Job created** | Emits when a WMS job is created. |
| **Job status changed** | Emits when a WMS job moves to a new status. |
| **Order lifecycle** | Emits when a WMS order is created, updated, changes status, or is deleted. |
## Account & Apps
### Starshipit Account
This tab is read-only. It shows whether the WMS add-on is enabled and displays the Starshipit account ID, name, type, plan, status, timezone, UTC offset, and currency.
### WMS Integration
| Setting or control | What it does |
| --- | --- |
| **Enable WMS integration** | Enables or disables the Starshipit WMS integration for the account. |
| **Expand bundle items** | Expands WMS bundle items into their components when printing shipments. |
| **WMS instance override** | Sends order events to a related account's WMS instance. Leave it unset to use the current account's instance. |
### Apps
| Setting or control | What it does |
| --- | --- |
| **Desktop Apps** | Provides downloads for the Windows and macOS desktop apps with WMS support. |
| **Mobile Apps** | Provides downloads for the Android and iOS WMS mobile apps. |
| **Mobile Sign In Code** | Generates a temporary code for signing the mobile scanner app into the Starshipit account. |
### Appearance
These preferences are stored for the device you are using.
| Setting or control | What it does |
| --- | --- |
| **Theme mode** | Uses the device theme or keeps WMS in light or dark mode. |
| **Interface scale** | Makes dashboard text and spacing denser or roomier. |
## System
| Setting or control | What it does |
| --- | --- |
| **Reset Transactional Data** | Permanently deletes allocations, inventory records, jobs, purchase orders, order records, stock movements, and process logs. It preserves account information, locations, products, suppliers, and packages, but resets product and package quantities to zero. You must enter `confirm` before the reset runs. |
:::warning
Resetting transactional data cannot be undone. Use it only when you intend to clear the WMS account's operational history while keeping its configuration.
:::
See [WMS outbound webhooks](/articles/14700000001025-wms-outbound-webhooks) for endpoint requirements, event payloads, signature verification, retries, and ordering.
## Not finding what you're looking for?
Not everything is managed from **Settings**.
| Looking for | Go to |
| --- | --- |
| Automation recipes and schedules | **Automations** in the left navigation |
| User roles, permissions, and interface policy assignments | **System > Roles & Permissions** |
| System events and errors | **System > Process Logs** |
| Setup walkthrough | **Help > Setup Guide** |
| Locations, zones, products, packages, and suppliers | **Setup** in the left navigation |
## Related articles
- [Locations and warehouse setup](/articles/14700000000033-starshipit-wms-locations-and-warehouse-setup)
- [Products and inventory configuration](/articles/14700000000006-starshipit-wms-products-and-inventory-configuration)
- [Orders and allocation](/articles/14700000000010-starshipit-wms-orders-and-allocation)
- [Receiving stock](/articles/14700000000008-starshipit-wms-receiving-stock)
---
# Set up Unleashed with Starshipit WMS
URL: https://support.starshipit.com/articles/14700000000054-set-up-unleashed-with-starshipit-wms
Canonical: https://support.starshipit.com/articles/14700000000054-set-up-unleashed-with-starshipit-wms
Markdown: https://support.starshipit.com/articles/14700000000054-set-up-unleashed-with-starshipit-wms.md
Updated: 2026-07-28
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Import Unleashed purchase orders into Starshipit WMS and configure SKU-based inventory writeback to an Unleashed warehouse.
Connect Unleashed through Starshipit, import selected Unleashed purchase orders into Starshipit WMS, and write WMS inventory back by SKU to an Unleashed warehouse.
## Before you begin
You need:
* An Unleashed account connected to the current Starshipit account.
* Permission to manage products, purchase orders and commerce settings in WMS.
* WMS product SKUs that exactly match the corresponding Unleashed product codes.
* The Unleashed warehouse code that will receive inventory updates.
If Unleashed is not connected yet, [connect Unleashed to Starshipit](/articles/204503225-connect-unleashed-to-starshipit) first.
:::important
Decide whether WMS or another system owns inventory in the destination Unleashed warehouse before enabling writeback. WMS uses each product's SKU as the Unleashed product code.
:::
## Prepare matching products
Create or import the products into WMS before importing Unleashed purchase orders. Each WMS SKU must match the Unleashed product code, including any punctuation.
An Unleashed purchase-order line without a matching WMS product is skipped. If none of an order's lines can be resolved, that purchase order is not imported.
## Import purchase orders from Unleashed
1. Go to **Purchase Orders** in WMS.
2. Select **Import from Unleashed**.
3. Search or filter the Unleashed purchase orders by status.
4. Select the purchase orders you want to import.
5. Choose **Draft** if the orders need review, or **Created** if they are ready for receiving.
6. Select **Import**.
7. Review the result for any orders or lines that could not be imported.
WMS matches purchase-order lines to products by SKU. It matches existing suppliers by name and creates a supplier when a valid matching name does not already exist. Imported quantities are whole units.
## Configure Unleashed inventory writeback
1. Go to **System > Settings > Inventory Writeback**.
2. Find **Unleashed Inventory Sync**.
3. Enter the exact **Unleashed warehouse code**.
4. Move away from the field to save the warehouse code.
5. Turn on **Auto Writeback**.
WMS sends inventory writeback attempts to that warehouse using each WMS SKU as the Unleashed product code.
## Understand automatic writeback
After a supported receipt, pick, shipment, manual adjustment or stocktake variance completes, WMS queues the Unleashed update in the background. The warehouse transaction does not wait for Unleashed and is not rolled back if the update fails.
If a WMS SKU does not exist in Unleashed, the writeback can fail. Review **System > Process Logs** before changing the WMS transaction.
## Run a manual inventory writeback
1. Go to **Inventory**.
2. Select the products you want to update.
3. Select **Writeback to Unleashed**.
4. Review the SKUs and current WMS quantities.
5. Select **Writeback to Unleashed** to queue the updates.
6. Go to **System > Process Logs** and confirm the updates completed.
Unlike providers that store a product link in WMS, Unleashed writeback evaluates selected products by SKU. Products missing from Unleashed can fail during processing.
## Verify the integration
1. Choose a WMS test product whose SKU matches an Unleashed product code.
2. Enter the destination Unleashed warehouse code.
3. Enable **Auto Writeback**.
4. Complete a controlled stock adjustment in WMS.
5. Confirm the quantity changed in the selected Unleashed warehouse.
6. Import a small Unleashed purchase order and confirm its supplier, products, quantities and status in WMS.
7. Check **System > Process Logs** for the Unleashed results.
## Troubleshooting
| Problem | What to check |
| --- | --- |
| Unleashed does not appear in WMS settings | Confirm Unleashed is connected to the current Starshipit account, then refresh the settings page. |
| **Auto Writeback** cannot be enabled | Enter and save an **Unleashed warehouse code** first. |
| A writeback fails for one product | Confirm the WMS SKU exactly matches an Unleashed product code and the product exists in the destination warehouse. |
| A purchase-order line is skipped | Confirm its Unleashed product code matches a WMS SKU and its quantity is greater than zero. |
| A purchase order is not imported | Confirm it has a supplier name and at least one line that resolves to a WMS product. Review the import result for the exact reason. |
| Inventory updates the wrong warehouse | Check the warehouse code in **Unleashed Inventory Sync** before sending another update. |
If the problem continues, contact [Starshipit support](https://help.starshipit.com) with the WMS account, Unleashed warehouse code, SKU or purchase-order number and approximate time of the event.
## Related articles
* [Understand WMS integrations](/articles/14700000000044-understand-wms-integrations)
* [Manage suppliers and purchase orders](/articles/14700000000007-suppliers-and-purchase-orders)
* [Receive stock in WMS](/articles/14700000000008-receiving-stock)
---
# Set up MYOB Acumatica with Starshipit WMS
URL: https://support.starshipit.com/articles/14700000000056-set-up-myob-acumatica-with-starshipit-wms
Canonical: https://support.starshipit.com/articles/14700000000056-set-up-myob-acumatica-with-starshipit-wms
Markdown: https://support.starshipit.com/articles/14700000000056-set-up-myob-acumatica-with-starshipit-wms.md
Updated: 2026-08-17
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Import MYOB Acumatica products and purchase orders into Starshipit WMS, then manually reconcile WMS inventory to an Acumatica warehouse.
Connect MYOB Acumatica through Starshipit, import products and open purchase orders into Starshipit WMS, and manually reconcile WMS on-hand inventory to a selected Acumatica warehouse.
## Before you begin
You need:
* A MYOB Acumatica integration connected and enabled in the current Starshipit account.
* Valid Acumatica API credentials and a successful connection test in Starshipit.
* **Include Unit of Measure (UOM) in SKU** turned off in the Starshipit integration settings.
* Permission to manage products, purchase orders and commerce settings in WMS.
* An active Acumatica warehouse that the API user can access.
If MYOB Acumatica is not connected yet, [connect MYOB Acumatica to Starshipit](/articles/13959285704335-connect-myob-acumatica-to-starshipit) first.
:::important
Decide which system owns inventory before reconciling live products. Manual reconciliation sends the current WMS on-hand quantity to the selected Acumatica warehouse and can overwrite its available quantity.
:::
## Prepare the Starshipit integration
1. In Starshipit, go to **Settings > Integrations** and open **MYOB Acumatica**.
2. Confirm the integration is enabled and its server, credentials, tenant, endpoint and optional branch settings are correct.
3. Turn off **Include Unit of Measure (UOM) in SKU**. WMS product sync supports base-UOM product identities only.
4. Select **Test Connection** and confirm the connection succeeds.
5. Select **Save**.
If Starshipit should confirm Acumatica shipments after tracking writeback, turn on **Confirm shipment on tracking writeback**. WMS does not send automatic sales movements to Acumatica, so your shipment-confirmation workflow remains responsible for sales stock changes.
## Import products from MYOB Acumatica
1. Go to **Products** in WMS.
2. Open the actions menu and select **Sync from MYOB Acumatica**.
3. Leave **Page Number** empty to import every page, or enter one page number for a smaller test.
4. Optionally enter specific **SKU Filters**, one per line or separated by commas. Leave **Page Number** empty when using SKU filters.
5. Select **Start Sync**.
6. Wait for the background sync to finish, then review its result.
7. Open a product and confirm its MYOB Acumatica source and SKU.
WMS matches the Acumatica **Inventory ID** to the WMS SKU and imports the stock item description as the product name. The sync creates the product link needed for reconciliation, but it does not import Acumatica stock quantities into WMS.
:::caution
The product sync can overwrite existing product data for the selected fields. Test with SKU filters before importing a large catalogue.
:::
## Import purchase orders from MYOB Acumatica
Import products before importing purchase orders so WMS can match each Acumatica line to an existing WMS SKU.
1. Go to **Purchase Orders** in WMS.
2. Open the actions menu and select **Import from MYOB Acumatica**.
3. Review the open purchase orders. Search by PO number, supplier or warehouse if required.
4. Select the purchase orders you want to import. You can keep selections while moving between pages.
5. Choose whether to import them as **Draft** or **Created**.
6. Select **Import**.
7. Review the import result, then open each imported purchase order and compare its supplier, required date, products, quantities and prices with MYOB Acumatica.
WMS creates a supplier when its Acumatica supplier name does not already exist. Purchase-order lines are matched by Acumatica product code to WMS SKU. A line that does not match an existing WMS product is not included, and a purchase order with no matching lines fails to import.
:::important
Review every imported purchase order before receiving stock. A purchase order can import with only the lines that matched WMS products.
:::
## Configure inventory reconciliation
1. Go to **System > Settings > Inventory Writeback** in WMS.
2. Find **MYOB Acumatica Inventory Sync**.
3. Select the active Acumatica warehouse that should receive WMS inventory quantities.
4. Turn on **Enable reconciliation**.
The Acumatica branch in Starshipit is separate from the reconciliation warehouse. WMS writes to the warehouse selected in **MYOB Acumatica Inventory Sync**.
## Understand how reconciliation works
MYOB Acumatica reconciliation is manual. WMS does not automatically send receipts, picks, shipments, adjustments or stocktake movements to Acumatica.
When you reconcile a linked product, WMS queues its current on-hand quantity for the selected Acumatica warehouse. A **Queued** result means the update was accepted for background processing, not that Acumatica has completed it. Check **System > Process Logs** for the final result.
Sales are intentionally excluded from reconciliation. This prevents WMS from deducting a shipment a second time when the existing Starshipit tracking-writeback flow confirms the shipment in Acumatica.
## Reconcile inventory manually
Use manual reconciliation after a stocktake, during go-live, or when WMS and Acumatica have drifted.
1. Go to **Inventory** in WMS.
2. Select the MYOB Acumatica-linked products you want to reconcile.
3. Select **Reconcile to MYOB Acumatica**.
4. Review the selected products and their current WMS on-hand quantities.
5. Select **Reconcile to MYOB Acumatica** to queue the updates.
6. Review which products were queued, skipped or failed to queue.
7. Go to **System > Process Logs** and confirm the queued updates completed.
Products without a MYOB Acumatica link or an enabled warehouse target are skipped.
## Verify the integration
1. Import one test stock item from MYOB Acumatica.
2. If you plan to import purchase orders, import one open test PO as **Draft** and confirm its supplier, matching product lines, quantities and prices.
3. Select a test warehouse and turn on **Enable reconciliation**.
4. Confirm the product has a known on-hand quantity in WMS.
5. Reconcile the product to MYOB Acumatica.
6. Confirm **System > Process Logs** shows a successful result.
7. Check the selected Acumatica warehouse and confirm its available quantity matches the WMS on-hand quantity.
## Troubleshooting
| Problem | What to check |
| --- | --- |
| MYOB Acumatica does not appear in WMS | Confirm the integration is enabled in the current Starshipit account and passes **Test Connection**, then refresh WMS. |
| Product sync says base-UOM identities are required | Turn off **Include Unit of Measure (UOM) in SKU** in the Starshipit MYOB Acumatica settings, save, then retry. |
| A product is missing after import | Confirm the stock item has an **Inventory ID**, check the page or SKU filters, and confirm the API user can read the item and its warehouse details. |
| **Import from MYOB Acumatica** is missing from Purchase Orders | Confirm MYOB Acumatica is enabled for the current Starshipit account and you have permission to create purchase orders. |
| An Acumatica purchase order is not listed | Only open purchase orders are available. Confirm it is still open and available to the connected Acumatica API user. |
| A purchase-order line is missing after import | Confirm its Acumatica product code exactly matches an existing WMS SKU, then correct or add the product before importing the PO again. |
| No warehouses are available | Confirm the Acumatica warehouse is active and available to the API user, then refresh **MYOB Acumatica Inventory Sync**. The Starshipit branch setting does not select the warehouse. |
| **Enable reconciliation** is unavailable | Select an active Acumatica warehouse first. |
| A product is skipped during reconciliation | Confirm the product was imported from MYOB Acumatica and reconciliation is enabled for the selected warehouse. |
| A product remains **Queued** | Check **System > Process Logs** for the completed background result or an Acumatica authentication, adjustment or release error. |
| A sale does not trigger reconciliation | This is expected. WMS excludes automatic sales movements; check the Starshipit shipment-confirmation and tracking-writeback settings instead. |
If the problem continues, contact [Starshipit support](https://help.starshipit.com) with the WMS account, Acumatica tenant, affected SKU or PO number, selected warehouse and approximate time of the event.
## Related articles
* [Understand WMS integrations](/articles/14700000000044-understand-wms-integrations)
* [Connect MYOB Acumatica to Starshipit](/articles/13959285704335-connect-myob-acumatica-to-starshipit)
* [Configure WMS products and inventory](/articles/14700000000006-starshipit-wms-products-and-inventory-configuration)
* [Maintain stock accuracy and make adjustments](/articles/14700000000020-adjust-stock-and-investigate-stock-movements)
---
# Set up WooCommerce with Starshipit WMS
URL: https://support.starshipit.com/articles/14700000000051-set-up-woocommerce-with-starshipit-wms
Canonical: https://support.starshipit.com/articles/14700000000051-set-up-woocommerce-with-starshipit-wms
Markdown: https://support.starshipit.com/articles/14700000000051-set-up-woocommerce-with-starshipit-wms.md
Updated: 2026-08-03
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Import WooCommerce products into Starshipit WMS and configure automatic or manual inventory writeback for linked products.
Connect WooCommerce through Starshipit, import WooCommerce products into Starshipit WMS, and keep linked product inventory aligned with WMS.
## Before you begin
You need:
* A WooCommerce store connected to the current Starshipit account.
* Permission to manage products and commerce settings in WMS.
* Unique, non-empty SKUs on the WooCommerce products or variations you want to manage.
If WooCommerce is not connected yet, [connect WooCommerce to Starshipit](/articles/203826249-connect-woocommerce-to-starshipit) first.
:::important
Decide whether WMS or another system owns WooCommerce inventory before enabling writeback. A manual WMS sync sends the current WMS on-hand quantity to WooCommerce.
:::
## Import products from WooCommerce
1. Go to **Products** in WMS.
2. Open the actions menu and select **Sync from WooCommerce**.
3. Choose the product fields to import.
4. Optionally enter SKU filters to limit the import.
5. Select **Start Sync**.
6. Review the result, then open a product and confirm its WooCommerce source and SKU.
Products are matched by SKU. The import creates the WooCommerce link WMS needs for inventory writeback.
## Configure WooCommerce inventory writeback
1. Go to **System > Settings > Inventory Writeback**.
2. Find **WooCommerce Inventory Sync**.
3. Confirm **Connected WooCommerce** is shown.
4. Turn on **Auto Writeback**.
WooCommerce does not require a WMS writeback-location selection. Only linked WooCommerce products are updated.
## Understand automatic writeback
After a supported receipt, pick, shipment, manual adjustment or stocktake variance completes, WMS queues the WooCommerce update in the background. The warehouse transaction does not wait for WooCommerce and is not rolled back if the update fails.
You can disable WooCommerce writeback for an individual product when WMS should not manage that product's WooCommerce inventory.
## Run a manual inventory sync
1. Go to **Inventory**.
2. Select the WooCommerce-linked products you want to update.
3. Select **Sync to WooCommerce**.
4. Review the products and current WMS quantities.
5. Select **Sync to WooCommerce** to queue the writeback.
6. Go to **System > Process Logs** and confirm the updates completed.
Products without an enabled WooCommerce link are skipped.
## Verify the integration
1. Import a test product from WooCommerce.
2. Enable **Auto Writeback**.
3. Complete a controlled stock adjustment in WMS.
4. Confirm the product's WooCommerce stock quantity changed.
5. Check **System > Process Logs** for the WooCommerce result.
## Troubleshooting
| Problem | What to check |
| --- | --- |
| WooCommerce does not appear in WMS settings | Confirm WooCommerce is connected to the current Starshipit account, then refresh the settings page. |
| A product is missing after import | Confirm the WooCommerce product or variation has a unique, non-empty SKU and review the product-sync result. |
| A product is skipped during writeback | Confirm it has a WooCommerce link and its provider writeback has not been disabled. |
| The WMS quantity does not appear in WooCommerce | Confirm WooCommerce stock management is enabled for the product, then check **System > Process Logs**. |
| Writeback fails intermittently | Review the process log for a WooCommerce API, authentication or rate-limit response before retrying. |
If the problem continues, contact [Starshipit support](https://help.starshipit.com) with the WMS account, WooCommerce store, SKU and approximate time of the sync.
## Related articles
* [Understand WMS integrations](/articles/14700000000044-understand-wms-integrations)
* [Configure WMS products and inventory](/articles/14700000000006-starshipit-wms-products-and-inventory-configuration)
* [Maintain stock accuracy and make adjustments](/articles/14700000000020-adjust-stock-and-investigate-stock-movements)
---
# Set up Adobe Commerce (Magento 2) with Starshipit WMS
URL: https://support.starshipit.com/articles/14700000000052-set-up-adobe-commerce-magento-2-with-starshipit-wms
Canonical: https://support.starshipit.com/articles/14700000000052-set-up-adobe-commerce-magento-2-with-starshipit-wms
Markdown: https://support.starshipit.com/articles/14700000000052-set-up-adobe-commerce-magento-2-with-starshipit-wms.md
Updated: 2026-08-06
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Import Adobe Commerce or Magento 2 products into Starshipit WMS and configure location-aware inventory writeback for each store.
Connect Adobe Commerce, also known as Magento 2, through Starshipit, import its products into Starshipit WMS, and keep inventory aligned for each connected store.
## Before you begin
You need:
* An Adobe Commerce or Magento 2 store connected to the current Starshipit account or an eligible source account.
* Permission to manage products and commerce settings in WMS.
* Unique, non-empty SKUs on the products you want to manage.
* An active Adobe Commerce inventory location for each writeback target.
:::warning
If you use Starshipit WMS, select **Token** as the authentication method in your Starshipit Magento 2 integration settings.
:::
If the store is not connected yet, [connect Adobe Commerce to Starshipit](/articles/213430403-connect-adobe-commerce-magento-2-to-starshipit) first.
:::important
Decide whether WMS or another system owns Adobe Commerce inventory before enabling writeback. A manual WMS sync sends the current WMS on-hand quantity to the selected location.
:::
## Import products from Adobe Commerce
WMS labels this provider **Magento2** in product-sync and inventory-writeback controls.
1. Go to **Products** in WMS.
2. Open the actions menu and select **Sync from Magento2**.
3. Under **Magento2 Store**, select the Starshipit account and store you want to import from. You must choose a source when more than one eligible family store is available.
4. Choose the product fields to import.
5. Optionally enter SKU filters to limit the import.
6. Select **Start Sync**.
7. Review the result, then open a product and confirm its Magento2 source and SKU.
Products are matched by SKU. The import creates the product link used for inventory writeback.
## Configure Adobe Commerce inventory writeback
1. Go to **System > Settings > Inventory Writeback**.
2. Find **Magento2 Inventory Sync**.
3. Review the default store and any linked source stores.
4. Select a **Writeback Location** for each store WMS should update.
5. Turn on **Auto Writeback** for each configured store.
The default row is used when a product is not assigned to a specific source store. A linked row uses that product's source Starshipit account and Magento 2 store.
Only products connected to Magento 2 and assigned to a target with an active location can be written back.
## Understand automatic writeback
After a supported receipt, pick, shipment, manual adjustment or stocktake variance completes, WMS queues the Adobe Commerce update in the background. The warehouse transaction does not wait for Adobe Commerce and is not rolled back if the update fails.
You can disable Magento 2 writeback for an individual product when WMS should not manage that product's store inventory.
## Run a manual inventory sync
1. Go to **Inventory**.
2. Select the Magento 2-linked products you want to update.
3. Select **Sync to Magento2**.
4. Review the products and current WMS quantities.
5. Select **Sync to Magento2** to queue the writeback.
6. Go to **System > Process Logs** and confirm the updates completed.
Products without an enabled Magento 2 link and writeback target are skipped.
## Verify the integration
1. Import a test product from Magento 2.
2. Select its store's writeback location.
3. Enable **Auto Writeback** for that store.
4. Complete a controlled stock adjustment in WMS.
5. Confirm the quantity changed at the selected Adobe Commerce location.
6. Check **System > Process Logs** for the Magento 2 result.
## Troubleshooting
| Problem | What to check |
| --- | --- |
| Magento 2 does not appear in WMS settings | Confirm Adobe Commerce is connected to the current or eligible source Starshipit account, then refresh the settings page. |
| No stores are listed | Confirm an Adobe Commerce integration is configured in the current Starshipit account family, then reopen the sync dialog. |
| No locations are available | Confirm the connected store has an active inventory location, then refresh **Magento2 Inventory Sync**. |
| **Auto Writeback** is unavailable | Select a **Writeback Location** for the target first. |
| A product is skipped | Confirm the product was imported or linked to Magento 2 and its provider writeback has not been disabled. |
| A quantity does not change | Check the product's source store, selected location and **System > Process Logs** for the returned Adobe Commerce error. |
If the problem continues, contact [Starshipit support](https://help.starshipit.com) with the WMS account, Adobe Commerce store, SKU, selected location and approximate time of the sync.
## Related articles
* [Understand WMS integrations](/articles/14700000000044-understand-wms-integrations)
* [Configure WMS products and inventory](/articles/14700000000006-starshipit-wms-products-and-inventory-configuration)
* [Maintain stock accuracy and make adjustments](/articles/14700000000020-adjust-stock-and-investigate-stock-movements)
---
# Set up NetSuite with Starshipit WMS
URL: https://support.starshipit.com/articles/14700000000058-set-up-netsuite-with-starshipit-wms
Canonical: https://support.starshipit.com/articles/14700000000058-set-up-netsuite-with-starshipit-wms
Markdown: https://support.starshipit.com/articles/14700000000058-set-up-netsuite-with-starshipit-wms.md
Updated: 2026-09-14
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Link NetSuite products to Starshipit WMS and configure automatic or manual inventory reconciliation for one NetSuite location.
Connect NetSuite through Starshipit, link eligible products to Starshipit WMS, and reconcile account-wide WMS on-hand inventory to one NetSuite location.
## Before you begin
You need:
* A NetSuite integration connected and enabled in the same Starshipit account as WMS.
* Token-based authentication configured for the Starshipit NetSuite integration. User-credential authentication is not supported for WMS inventory reconciliation.
* A NetSuite role that can use REST web services, read inventory items and location quantities, and create inventory adjustments for the selected location and account.
* **Disable writeback** turned off in the Starshipit NetSuite integration settings.
* Permission to manage products and commerce settings in WMS. Client-scoped users cannot configure or run account-wide NetSuite reconciliation.
* The internal IDs for the NetSuite location, inventory adjustment account, and subsidiary when one is required.
* Unique, non-empty WMS SKUs that match the NetSuite SKU field selected in Starshipit: **Item ID** or **UPC Code**.
If NetSuite is not connected yet, [connect NetSuite to Starshipit](/articles/213384326-connect-netsuite-to-starshipit) first.
:::important
Decide whether WMS or another system owns inventory before enabling writeback. NetSuite reconciliation sets the selected location to the account-wide WMS on-hand quantity and can create an inventory adjustment in NetSuite.
:::
Batch- and serial-tracked WMS products are not supported. Use products with **Standard** as their tracking type.
## Prepare the Starshipit NetSuite integration
1. In Starshipit, go to **Settings > Integrations** and open **NetSuite**.
2. Confirm **Enable NetSuite** is turned on.
3. Select **Token-Based** as the authentication method and confirm the account ID, consumer key, consumer secret, token ID, and token secret are saved.
4. Confirm the selected item SKU field matches the values stored as WMS SKUs.
5. Turn off **Disable writeback**.
6. Select **Test to ensure it works**, then save the integration.
The NetSuite token role must also be able to create inventory adjustments. Test this permission with one controlled reconciliation before enabling automatic writeback.
## Configure NetSuite inventory in WMS
1. In WMS, go to **System > Settings > Direct Integrations**.
2. Find **NetSuite Inventory**, select **Verify connection**, and confirm the **Connected** status appears.
3. Enter the **NetSuite location ID** and a **Location name**. You can select a suggested ID when WMS finds one in the returned inventory data.
4. Enter the **Subsidiary ID** when the selected NetSuite account and location require one.
5. Enter the **Inventory adjustment account ID**.
6. Turn on **Enable integration**.
7. Leave **Automatic writeback** off while you link and test products.
8. Wait for **Saved**.
WMS settings save automatically when you leave a text field or change a switch. If **Not saved** appears, correct the reported problem and select **Retry**. Complete any required fields if **Unsaved changes** appears.
| Setting | What it does |
| --- | --- |
| **NetSuite location ID** | Selects the one NetSuite location that receives inventory reconciliation for this WMS account. |
| **Location name** | Adds a display name for the mapped location in WMS. It does not change NetSuite. |
| **Subsidiary ID** | Identifies the NetSuite subsidiary used on inventory adjustments when one is required. |
| **Inventory adjustment account ID** | Identifies the NetSuite account used for inventory-adjustment transactions. |
| **Enable integration** | Allows product linking and manual reconciliation. |
| **Automatic writeback** | Queues reconciliation after supported manual adjustments and stocktake corrections. |
**Verify connection** confirms that WMS can read NetSuite products through the Starshipit integration. It does not create an inventory adjustment or confirm write permission.
## Link WMS products to NetSuite
WMS links products by exact SKU before it can reconcile their inventory.
1. In **System > Settings > Direct Integrations**, find **NetSuite Inventory**.
2. Under **Product links**, select **Find exact SKU matches**.
3. Review each WMS SKU, product name, and matching NetSuite inventory item ID.
4. Select the **Confirm links** button to save the displayed matches. The button includes the number of links that will be saved.
5. Select **Find next matches** when more eligible products remain.
A product is offered only when:
* It is visible in WMS and uses **Standard** as its tracking type.
* Its normalised SKU is unique in the WMS account.
* Exactly one NetSuite inventory item has the same SKU.
* It does not already have a NetSuite product link.
WMS saves the NetSuite inventory item ID as the product's external identity. Correct duplicate or mismatched SKUs before trying to link the product again.
## Understand NetSuite reconciliation
WMS compares the product's total on-hand quantity across the WMS account with the quantity at the mapped NetSuite location. It then creates only the inventory adjustment needed to make NetSuite match WMS. No adjustment is created when the quantities already match.
Manual reconciliation can be run at any time for linked products. Automatic reconciliation is limited to manual WMS inventory adjustments and posted stocktake corrections.
Receipts, picks, packing, shipments, and internal WMS transfers do not trigger automatic NetSuite reconciliation. Shipment inventory remains managed by the existing Starshipit-to-NetSuite fulfilment and tracking-writeback flow.
Reconciliation runs in the background. The WMS stock movement is not rolled back if NetSuite rejects an update. Review the final outcome in **System > Process Logs**.
## Reconcile inventory manually
Use manual reconciliation during setup, after a stocktake, or when WMS and NetSuite inventory have drifted.
1. Go to **Inventory** in WMS.
2. Select between 1 and 50 NetSuite-linked products.
3. Select **Reconcile to NetSuite**.
4. Select **Preview reconciliation**.
5. Review the WMS quantity, NetSuite quantity, proposed change, and status for each product.
6. Select the **Queue reconciliations** button for the products marked ready. The button includes the number of updates that will be queued.
7. Go to **System > Process Logs** and confirm the queued updates completed.
8. Check the mapped NetSuite location and confirm its quantity matches the WMS on-hand quantity.
Products that are already in sync are not queued. Products that are unsupported, unlinked, or no longer available at the mapped NetSuite location must be corrected before they can be reconciled.
## Enable automatic writeback
Enable automatic writeback only after a controlled manual reconciliation succeeds.
1. Go to **System > Settings > Direct Integrations**.
2. Find **NetSuite Inventory**.
3. Turn on **Automatic writeback**.
4. Wait for **Saved**.
5. Complete a small manual inventory adjustment or post a stocktake correction for a linked test product.
6. Confirm **System > Process Logs** shows a successful NetSuite reconciliation.
7. Check the mapped NetSuite location and confirm the final quantity matches WMS.
## Verify the integration
1. Choose one untracked product with a unique SKU and known quantities in WMS and NetSuite.
2. Link the product under **NetSuite Inventory**.
3. Run a manual reconciliation from **Inventory**.
4. Confirm the process log shows a successful result.
5. Confirm the mapped NetSuite location now matches the account-wide WMS on-hand quantity.
6. Enable automatic writeback only if WMS should continue reconciling manual adjustments and stocktake corrections.
## Troubleshooting
| Problem | What to check |
| --- | --- |
| **NetSuite Inventory** does not appear | Confirm NetSuite is enabled in the same Starshipit account and that you have permission to manage products and commerce settings. Client-scoped access is not supported. |
| **Verify connection** fails | Confirm the Starshipit integration uses token-based authentication and the token role can use REST web services and read inventory items. Retest the connection in Starshipit. |
| No location IDs are suggested | Confirm the token role can read item location quantities and that NetSuite inventory items have quantities at the intended location. You can enter the internal location ID manually. |
| **Enable integration** cannot be saved | Enter both the **NetSuite location ID** and **Inventory adjustment account ID**. Add a subsidiary ID when NetSuite requires one. |
| No product matches are found | Confirm the WMS SKU is unique, uses the configured NetSuite **Item ID** or **UPC Code**, and belongs to a visible, untracked WMS product. |
| A product shows as unsupported | Batch- and serial-tracked products cannot use this integration. |
| A product shows as not linked or stale | Confirm the WMS SKU still exactly matches the configured NetSuite SKU field and that the inventory item exists at the mapped location. Correct the SKU or location, then preview again. Contact support if the saved item link must be replaced. |
| Reconciliation is rejected | Confirm **Disable writeback** is off in Starshipit and the NetSuite role can create inventory adjustments using the selected location, adjustment account, and subsidiary. |
| Automatic writeback does not run | Confirm the integration and **Automatic writeback** are enabled, the product is linked, and the event was a manual inventory adjustment or posted stocktake correction. |
| A receipt, pick, shipment, or transfer does not trigger reconciliation | This is expected. These movements are excluded from automatic NetSuite reconciliation. Shipment inventory uses the existing Starshipit fulfilment flow. |
| A queued update has no final result | Check **System > Process Logs** for a completed, retrying, or rejected NetSuite inventory update. |
If the problem continues, contact [Starshipit support](https://help.starshipit.com) with the WMS account, affected SKU, NetSuite inventory item ID, mapped location ID, and approximate time of the reconciliation.
## Related articles
* [Understand WMS integrations](/articles/14700000000044-understand-wms-integrations)
* [Connect NetSuite to Starshipit](/articles/213384326-connect-netsuite-to-starshipit)
* [View inventory and stock levels](/articles/14700000000014-view-inventory-and-stock-levels)
* [Adjust stock and investigate stock movements](/articles/14700000000020-adjust-stock-and-investigate-stock-movements)
* [Run stocktakes and cycle counts](/articles/14700000000015-run-stocktakes-and-cycle-counts)
---
# Set up Cin7 Core with Starshipit WMS
URL: https://support.starshipit.com/articles/14700000000035-set-up-cin7-core-with-starshipit-wms
Canonical: https://support.starshipit.com/articles/14700000000035-set-up-cin7-core-with-starshipit-wms
Markdown: https://support.starshipit.com/articles/14700000000035-set-up-cin7-core-with-starshipit-wms.md
Updated: 2026-09-14
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Connect Cin7 Core directly to Starshipit WMS, map a warehouse, import opening stock, and manage product, purchase order and inventory syncs.
Connect Cin7 Core directly to Starshipit WMS to keep products, purchase orders and bin-level inventory aligned while your team manages day-to-day warehouse locations and movements in WMS. Cin7 Core was previously known as DEAR Inventory.
## Before you begin
You need:
* A Cin7 Core account with API access and webhooks available.
* Permission to create an API application in Cin7 Core.
* Permission to manage settings and products, and view and import locations in Starshipit WMS.
* Access to **Operations** and **Process Logs** if you will monitor the rollout yourself.
* One active, top-level Cin7 Core warehouse for this WMS account.
* Active Cin7 Core bins for the WMS locations used in receiving, storage, staging, equipment and packing.
* If Cin7 Core has stock without a bin, a visible WMS **Staging dock**, **Quarantine** or **Overflow** location that is not linked to a Core bin.
* A secure password manager for the API application key and webhook bearer secret.
This direct WMS integration is separate from the standard [Cin7 Core integration](/articles/211651203-cin7-core-integration) used to import sales orders into Starshipit or request shipping rates from Cin7 Core.
## Decide which system owns each type of data
:::important
Manage the product catalogue, suppliers and Advanced Purchase orders in Cin7 Core. Link Core bins to WMS locations so stock changes can stay aligned in both systems. Enable inventory writeback before starting WMS warehouse movements.
:::
| Data | Source of truth | How the integration handles it |
| --- | --- | --- |
| Product catalogue | Cin7 Core | WMS imports supported products and updates the Core-managed product fields. |
| Suppliers and Advanced Purchase orders | Cin7 Core | WMS imports eligible purchase orders and matches or creates suppliers by name. |
| Bin stock | Cin7 Core and WMS | WMS reconciles Core stock by linked bin, preserving batch, serial and expiry details. Enabled writeback sends supported WMS changes to Core. |
| Bins and WMS locations | Cin7 Core for bin identity; WMS for operational settings | Location import creates stable Core bin links. Later Core location changes are not imported automatically. |
| Putaway, replenishment and internal movements | WMS | Enabled writeback sends supported movements between linked bins to Core. |
| Sales and shipping | Your existing Starshipit and Cin7 Core workflow | This direct integration does not replace the sales-order and shipment integration. |
The diagram below shows the sales, shipping, WMS import, webhook and writeback flows between the three systems.
```mermaid
sequenceDiagram
accTitle: Cin7 Core, Starshipit and Starshipit WMS data flows
accDescr: Swimlane diagram showing sales, shipping, product, purchasing, inventory, webhook and writeback flows between the three systems
participant C as Cin7 Core
participant S as Starshipit
participant W as Starshipit WMS
rect rgb(240, 247, 255)
Note over C,S: Sales and shipping
S->>C: Request eligible sales orders or fulfilments
C-->>S: Return sales order or fulfilment data
S->>C: Write back carrier and tracking details
C->>S: Request available shipping rates
S-->>C: Return carriers, services and rates
C->>S: Request shipment and label
S-->>C: Return label and tracking details
end
rect rgb(243, 250, 246)
Note over C,W: WMS imports and webhooks
W->>C: Request product catalogue
C-->>W: Return supported Stock products
W->>C: Request opening stock
C-->>W: Return stock for the mapped warehouse
C-->>W: Product/Updated webhook
W->>C: Fetch the latest product
C-->>W: Return updated product data
C-->>W: Stock/AvailableStockLevelChanged webhook
W->>C: Fetch current warehouse stock
C-->>W: Return mapped-warehouse stock
Note over W: Reconcile linked bins and tracking details
C-->>W: Purchase/OrderAuthorised or Purchase/Updated webhook
W->>C: Fetch the latest Advanced Purchase
C-->>W: Return purchase order, supplier and product data
end
rect rgb(255, 248, 235)
Note over C,W: WMS writeback
W->>C: Write back completed purchase receipt
W->>C: Write back bin adjustments and internal transfers
opt Outbound Pick/Pack enabled
W->>C: Authorise and verify Pick and Pack
W->>S: Request shipping label
S->>C: Write back Ship and tracking
end
end
```
## Start with a fresh WMS instance
Set up Cin7 Core before starting warehouse operations. Use a fresh WMS instance, or review **System > Settings > Data Management** if you are deliberately starting over with an existing instance.
:::warning
A transactional data reset permanently deletes inventory, orders, jobs and stock movements. It preserves products, locations and configuration. Only reset an existing instance when you intend to remove its operational data.
:::
Arrange a setup window in which users and connected systems pause product, stock and purchase changes in Cin7 Core. Keep those changes paused from before the first import until webhooks are registered and the final comparison below is complete. Changes made before registration are not captured by these webhooks.
## Connect Cin7 Core while the integration is disabled
Keep **Enable Cin7 Core sync**, **Enable Cin7 Core writeback** and **Enable outbound Pick/Pack writeback** off while you configure and test the connection.
### Create Cin7 Core API credentials
1. Open the Cin7 Core API setup page.
2. Create a dedicated API application for Starshipit WMS.
3. Copy the **Account ID** and **Application key** into your password manager.
See [Connecting to the Cin7 Core API](https://help.core.cin7.com/hc/en-us/articles/9982480315407-Connecting-to-the-Cin7-Core-API) for detailed API setup instructions.
Treat the account ID and application key like a username and password. Do not send them by email, place them in process notes or share them with users who do not manage the integration.
### Enter the connection details in WMS
1. In WMS, go to **System > Settings**.
2. Under **Products & Inventory**, select **Direct Integrations**.
3. Find **Cin7 Core**.
4. Enter the **Core account ID** and **Application key**.
5. Create a long, unique secret in your password manager and enter it in **Webhook bearer secret**. This secret is created by you; it is not the Cin7 Core application key.
6. Leave **Enable Cin7 Core sync** and **Enable Cin7 Core writeback** off.
7. Select **Test connection**.
Settings save automatically when you leave a text field or change a selection. Wait for **Saved** before continuing. If **Not saved** appears, correct the reported problem and select **Retry**. Complete any required fields if **Unsaved changes** appears. **Test connection** also saves changed connection details before testing.
When the test succeeds, WMS displays the number of active Cin7 Core warehouse locations it found. Saved application keys and webhook secrets are not displayed again. Enter a new value only when you intend to replace the saved value.
### Map the warehouse and import locations
1. Select the matching **Cin7 Core warehouse**.
2. Wait for **Saved**.
3. Select **Import locations from Cin7 Core** to open the import flow in **Setup > Locations**.
4. Review the import summary, then select **Import locations**.
5. Wait for the import to finish and review any failed rows.
6. Confirm that every location used for bin-based movements has a Core link, including receiving, staging, equipment and packing locations.
One WMS account maps to one active, top-level Cin7 Core warehouse. The import copies active descendants and links them to their Core IDs. WMS reuses existing Core ID links first, then matches unlinked locations by name without regard to letter case. Existing same-name locations keep their type and settings; new locations are created as **Pick Face** locations. Duplicate names or conflicting mappings require correction before the affected rows can import.
Later Core additions, renames, hierarchy changes and deactivations are not imported automatically. Run the import again when needed and review the links. Continue managing WMS location types, barcodes, capacity, sequence, zones and restrictions in WMS.
### Choose a location for stock without a Core bin
If Cin7 Core holds stock at warehouse level without a bin, return to the Cin7 Core settings card and select a **WMS reconciliation location**, then wait for **Saved**. Choose a visible **Staging dock**, **Quarantine** or **Overflow** location that is not already linked to a Core bin.
This location receives stock that has no Core bin. It does not replace a missing mapping for stock that already belongs to a Core bin. Assign unbinned stock to a Core bin before using bin-based outbound movements.
## Enable inbound sync
1. Confirm that the location import has finished and the warehouse mapping is correct.
2. Turn on **Enable Cin7 Core sync**.
3. Keep both writeback settings off during the initial import.
4. Wait for **Saved** to unlock the **Initial rollout** actions.
## Import products and opening stock
### Import the product catalogue
1. Under **Initial rollout**, select **Import products**.
2. Go to **Operations > Background work**.
3. Find **Cin7 Core product import** under **Tracked jobs**.
4. Wait for the job to complete before importing opening stock.
WMS imports active Cin7 Core products that have the **Stock** type and a non-empty SKU. A product import or webhook updates these Core-managed fields:
* **Product details:** Name, barcode, brand, description and tags.
* **Pricing:** Price Tier 1 and average cost.
* **Physical and customs details:** Dimensions, weight and country of origin.
* **Tracking:** Batch or serial tracking based on the Cin7 Core costing method.
WMS hides a linked Stock product when it is deprecated in Cin7 Core. Edit these managed fields in Cin7 Core because a future import or product webhook can replace the WMS values.
### Import Assembly bills of materials
The product import also converts supported Cin7 Core Assembly bills of materials (BOMs) into WMS **exploding bundles**. Orders for these bundles use the component SKUs rather than picking a stocked bundle SKU.
To import a BOM, it must have:
* The **Assembly** BOM type and **Quantity to produce** set to `1`.
* At least one stock component, with a product ID, SKU and positive whole-unit quantity.
* No service components, wastage, duplicate components or nested bundles.
* Component products that can be imported and pass WMS bundle validation.
After the import completes, open a sample bundle in **Products** and check its bundle mode, component SKUs and quantities. Review **System > Process Logs** for any skipped BOMs before using them on orders.
Manage the BOM in Cin7 Core. A later product import or product-update webhook can replace the WMS component configuration and set its mode to **Explode**. This import does not create pre-kitted stock or write assemblies back to Cin7 Core. See [Configure WMS products and inventory](/articles/14700000000006-starshipit-wms-products-and-inventory-configuration) for the difference between exploding and require-stock bundles.
### Apply opening stock
Apply opening stock after both the location and product imports have finished. This is a one-time setup action for products with no existing WMS stock.
1. Select **Apply opening stock** under **Initial rollout**.
2. Go to **Operations > Background work**.
3. Find **Cin7 Core opening stock** under **Tracked jobs** and wait for completion.
4. Review warnings in **System > Process Logs**.
5. Compare representative SKUs in both systems by bin, quantity and any batch, serial or expiry details.
WMS supports whole-unit untracked, batch-tracked and serial-tracked opening stock. Stock goes to its linked WMS bin, or to the reconciliation location when the Core row has no bin.
:::caution
Do not use opening stock to overwrite active inventory. Missing mappings, fractional quantities and conflicting existing WMS stock require review before continuing.
:::
## Register webhooks after the imports
1. Return to the Cin7 Core settings card.
2. Under **Initial rollout**, select **Register webhooks** when you are ready for ongoing changes.
3. Confirm that WMS reports four configured webhooks.
4. While Core changes remain paused, compare the imported product data and stock by bin and tracking identity against Core. Review any eligible purchase orders that need to reach WMS.
5. Resolve missing or mismatched records before resuming changes. If Core changed during setup, do not assume registration replays those changes: refresh products with **Import products**, and contact Starshipit support to reconcile stock or missing purchases. Do not rerun opening stock over existing WMS inventory.
6. Resume Core changes only after this comparison is complete and all discrepancies are resolved.
WMS creates or reactivates these subscriptions. You do not need to copy webhook URLs or authentication values into Cin7 Core manually.
| Cin7 Core event | What WMS does |
| --- | --- |
| `Product/Updated` | Fetches the latest product record. |
| `Stock/AvailableStockLevelChanged` | Reconciles stock by linked bin and tracking identity. |
| `Purchase/OrderAuthorised` | Imports an eligible authorised Advanced Purchase order. |
| `Purchase/Updated` | Fetches the latest eligible Advanced Purchase order. |
## Understand ongoing sync flows
Cin7 Core webhooks notify WMS that something changed. WMS then retrieves the latest record from Cin7 Core before processing it.
### Product updates
Cin7 Core remains the product catalogue master. When an imported product changes, WMS refreshes the Core-managed product fields. Only active Stock products with a non-empty SKU are imported. Linked Stock products marked as deprecated in Cin7 Core are hidden in WMS.
You can refresh the catalogue from the Products page using **Sync from Cin7 Core**. This requires the direct integration to be enabled and the relevant settings and product permissions. Follow the import in **Operations > Background work**.
### Purchase orders
WMS imports a purchase order when all of these conditions are met:
* It is an **Advanced Purchase** in Cin7 Core.
* Its order stage is **Authorised**.
* It belongs to the mapped Cin7 Core warehouse.
* It is not service-only.
* It contains at least one stock line, and every line has a product and SKU, a positive whole-unit quantity and a valid non-negative price.
The purchase order appears in WMS with its Cin7 Core order number, supplier, dates, products, quantities and prices. If a product on the order is not yet linked, WMS imports the product before creating the purchase order.
Make purchase-order changes in Cin7 Core before receiving begins. Once the WMS purchase order has receiving activity, later Cin7 Core updates do not replace its lines.
### Inventory changes
For a stock-change event, WMS fetches the current Core stock and compares it with WMS stock by linked bin, batch or serial number and expiry. Unbinned Core stock uses the selected reconciliation location.
WMS moves existing stock between locations before applying any remaining quantity adjustment. It preserves tracking and receipt details. A missing mapping, fractional quantity, required removal from allocated or container-held stock, or unresolved outbound write sends the product for review instead of applying a partial reconciliation.
Changes imported from Core do not generate another writeback to Core. Review **Background work** and **Process Logs** when a difference remains.
## Enable inventory writeback after testing
**Enable Cin7 Core writeback** adds these outbound flows:
| WMS action | Cin7 Core result |
| --- | --- |
| Receive stock against a Cin7 Core-sourced Advanced Purchase order | WMS sends the completed receipt to the matching Cin7 Core purchase using the actual receiving bin. |
| Adjust or write off stock, or complete a stocktake or cycle-count correction | WMS sends the resulting quantity for each affected linked bin and tracking identity. |
| Move stock between linked WMS locations, including putaway and replenishment | WMS sends a Core stock transfer between the linked bins. |
Writebacks run in the background. A Cin7 Core error does not undo the completed WMS receipt or inventory adjustment.
For purchase receipts, WMS handles Cin7 Core's **Use put away** setting automatically.
To test and enable writeback:
1. Confirm that the connection, warehouse mapping and webhooks are working.
2. Complete the product import and review any opening-stock warnings.
3. Authorise a small test Advanced Purchase order in Cin7 Core for the mapped warehouse.
4. Confirm that the order and its products appear correctly in WMS.
5. Confirm that receiving and movement locations are linked to active Core bins.
6. Turn on **Enable Cin7 Core writeback** and wait for **Saved** before receiving or moving stock in WMS.
7. Receive the controlled purchase, then test a bin movement and an adjustment. Confirm quantities and tracking details in both systems.
8. Review **Operations > Background work** and **System > Process Logs** before starting normal warehouse operations.
Writeback is not retroactive. Receipts, adjustments and movements completed while writeback is off are not sent later when you enable it.
## Optionally enable outbound Pick/Pack writeback
**Enable outbound Pick/Pack writeback** is separate from inventory writeback and is off by default. For supported sales imported at **Ordered**, WMS authorises and verifies Cin7 Core Pick and Pack before requesting a shipping label. Starshipit continues to handle Ship and tracking updates.
Use this only when all these conditions apply:
* The Starshipit Cin7 Core connection uses API v2 sale import for the same Core account, without enhanced fulfilment import.
* The order is a full **Simple Sale** in the mapped warehouse with one existing sale-level fulfilment.
* The full sale is packed into one Starshipit package, with at most 20 distinct products.
* All packed stock has exact bin and batch or serial attribution where required.
* The sale has no previous shipment or return.
Partial quantities, Advanced Sales, multiple fulfilments and multiple packages are not supported by this setting. Existing authorised Pick/Pack records must match exactly; WMS does not overwrite existing work.
1. Prepare an eligible Ordered sale in a non-production Cin7 Core and Starshipit account.
2. Turn on **Enable outbound Pick/Pack writeback** and wait for **Saved**.
3. Pack the full sale in WMS and request its label.
4. Confirm Pick and Pack in Core, the label in Starshipit, and the subsequent Ship and tracking update before enabling this workflow for live orders.
If Pick/Pack validation or writeback fails, printing is blocked. Review the Core sale and process status before continuing. Do not delete or requeue an uncertain operation to bypass the error. Successful Pick/Pack alone does not confirm shipping succeeded.
## Monitor background work and process logs
Use **Operations > Background work** for a quick operational view:
* **Tracked jobs** shows product imports and opening-stock imports, including progress and warning counts.
* **Queue activity** shows recent product updates, stock updates, purchase-order updates and writebacks.
* **Retryable** means WMS plans another attempt after a temporary response such as rate limiting.
* **Needs review**, **Failed** or **Dead letter** means you should inspect the error before changing data in either system.
Use **System > Process Logs** for detailed warnings and audit information. Look for entries related to Cin7 Core, inventory sync, purchase orders or stock movements.
If a writeback outcome is uncertain, check Cin7 Core before repeating the WMS action. WMS avoids automatically repeating an operation when doing so could create a duplicate receipt or adjustment.
## Understand the limitations
The direct integration does not:
* Automatically import later changes to the Cin7 Core location catalogue.
* Send bin-based movements from locations without valid Core bin links.
* Replace the existing Starshipit and Cin7 Core sales-order and shipment flow.
* Write back cross-warehouse transfers, assemblies or kitting, or returns.
* Apply fractional stock quantities automatically.
* Cancel or delete an imported WMS purchase order if the Cin7 Core purchase later becomes unauthorised or moves outside the mapped warehouse.
* Map more than one Cin7 Core warehouse to one WMS account.
## Troubleshooting
| Problem | What to check |
| --- | --- |
| The connection test fails | Confirm the account ID and application key belong to the correct Cin7 Core company, the API application is active and the values were copied without extra spaces. |
| The expected warehouse is missing | WMS lists active, top-level Cin7 Core locations only. Check the location in Cin7 Core, then test the connection again. |
| A Cin7 Core location import cannot start | Complete the Cin7 Core credentials and mapped warehouse, then wait for **Saved**. Resolve duplicate location names beneath the warehouse or ambiguous same-name WMS locations, then wait for any other location import to finish. |
| An Initial rollout button is disabled | Turn on **Enable Cin7 Core sync** and wait for **Saved**. Complete any required fields or resolve a **Not saved** error. Writeback can remain off. |
| A product is missing | Confirm it is an active Cin7 Core **Stock** product with a non-empty SKU, then check Background work. |
| A purchase order is missing | Confirm it is an authorised, non-service Advanced Purchase for the mapped warehouse and every stock line has a product, SKU, positive whole-unit quantity and valid non-negative price. |
| Opening stock has warnings | Check for existing WMS stock, fractional quantities, missing bin links or unbinned Core stock without a reconciliation location. |
| Inventory differs after a webhook | Check bin links, tracking details, fractional quantities, allocated or container-held stock, and unresolved outbound writes. Review Process Logs. |
| Webhooks stop arriving after the secret changes | Do not rotate the webhook bearer secret during live processing. Contact Starshipit support to coordinate the secret change and webhook registration. |
| A receipt or adjustment did not write back | Confirm both sync and writeback are enabled, the record is linked to Cin7 Core, and the operation was completed after writeback was enabled. Check Background work and Process Logs. |
If the problem continues, contact [Starshipit support](https://help.starshipit.com) with the affected WMS account, SKU or purchase-order number, the time of the event and the Background work or Process Logs status. Do not include API keys or webhook secrets.
## Related articles
* [Cin7 Core integration for sales orders and shipping](/articles/211651203-cin7-core-integration)
* [Set up WMS locations and your warehouse](/articles/14700000000033-starshipit-wms-locations-and-warehouse-setup)
* [Configure WMS products and inventory](/articles/14700000000006-starshipit-wms-products-and-inventory-configuration)
* [Manage suppliers and purchase orders](/articles/14700000000007-suppliers-and-purchase-orders)
* [Receive stock in WMS](/articles/14700000000008-receiving-stock)
---
# Set up Etsy with Starshipit WMS
URL: https://support.starshipit.com/articles/14700000000057-set-up-etsy-with-starshipit-wms
Canonical: https://support.starshipit.com/articles/14700000000057-set-up-etsy-with-starshipit-wms
Markdown: https://support.starshipit.com/articles/14700000000057-set-up-etsy-with-starshipit-wms.md
Updated: 2026-08-13
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Import Etsy products into Starshipit WMS and configure automatic or manual inventory writeback for linked variants.
Connect Etsy through Starshipit, import Etsy variants into Starshipit WMS, and keep linked inventory quantities aligned with WMS.
## Before you begin
You need:
* An Etsy store connected to the current Starshipit account.
* Permission to manage products and commerce settings in WMS.
* A unique, non-empty SKU on each inventory-managed Etsy variant you want to import.
If Etsy is not connected yet, [connect Etsy to Starshipit](/articles/206090525-connect-etsy-to-starshipit) first.
:::important
Decide whether WMS or another system owns Etsy inventory before enabling writeback. Etsy accepts inventory quantities from `0` to `999`, so writeback fails when a linked product's WMS on-hand quantity is outside that range.
:::
## Import products from Etsy
1. Go to **Products** in WMS.
2. Open the actions menu and select **Sync from Etsy**.
3. Choose the fields to import. **SKU** is required; you can also import the product title, image and sale price.
4. Optionally select **Include variant title in product name** to append each variant title to the imported product name.
5. Optionally enter a page number or add SKU filters. Leave both fields empty to import every product page.
6. Select **Start Sync**.
7. Review the sync result, then open a product and confirm its Etsy source and SKU.
The import runs in the background and matches products by SKU. It overwrites the selected fields on existing matching products and creates the Etsy link required for inventory writeback.
WMS can import only Etsy variants that have inventory management turned on and a non-empty SKU. If Etsy returns the same SKU more than once, WMS imports the first matching variant and reports the duplicates as skipped.
## Configure Etsy inventory writeback
1. Go to **System > Settings > Inventory Writeback**.
2. Find **Etsy Inventory Sync**.
3. Confirm **Connected Etsy** is shown.
4. Turn on **Auto Writeback**.
Etsy does not require a WMS writeback-location selection. Only products linked to Etsy are updated.
## Understand automatic writeback
After a supported receipt, pick, shipment, manual adjustment or stocktake variance completes, WMS queues the current on-hand quantity for Etsy in the background. The warehouse transaction does not wait for Etsy and is not rolled back if Etsy rejects the update.
You can disable Etsy writeback for an individual product when WMS should not manage that product's Etsy inventory.
## Run a manual inventory sync
Use a manual sync after a stocktake, during go-live or when you need to correct inventory drift.
1. Go to **Inventory**.
2. Select the Etsy-linked products you want to update.
3. Select **Sync to Etsy**.
4. Review the products and current WMS quantities.
5. Select **Sync to Etsy** to queue the writeback.
6. Go to **System > Process Logs** and confirm the updates completed.
Products without an enabled Etsy link are skipped.
## Verify the integration
1. Import a test Etsy variant with a unique SKU.
2. Confirm the WMS product shows an Etsy connection.
3. Enable **Auto Writeback**.
4. Complete a controlled stock adjustment that leaves the WMS on-hand quantity between `0` and `999`.
5. Confirm the Etsy quantity changed.
6. Check **System > Process Logs** for the Etsy writeback result.
## Troubleshooting
| Problem | What to check |
| --- | --- |
| Etsy does not appear in WMS | Confirm Etsy is connected to the current Starshipit account, then refresh the WMS page. |
| A variant is missing after import | Confirm the variant has inventory management turned on and a unique, non-empty SKU. Review the sync result for missing data or skipped duplicates. |
| Existing product details changed | The import overwrites the fields selected in the sync window for products with matching SKUs. Restore the affected WMS values, then select only the fields WMS should update in future syncs. |
| A product is skipped during a manual sync | Confirm the product has an enabled Etsy link. |
| Automatic writeback does not run | Confirm the product has an enabled Etsy link and **Auto Writeback** is turned on. |
| The quantity is rejected | Confirm the WMS on-hand quantity is a whole number from `0` to `999`. |
| A writeback fails | Check **System > Process Logs** for an Etsy authorization, product-link or API error before retrying. |
If the problem continues, contact [Starshipit support](https://help.starshipit.com) with the WMS account, Etsy shop, SKU and approximate time of the sync.
## Related articles
* [Understand WMS integrations](/articles/14700000000044-understand-wms-integrations)
* [Configure WMS products and inventory](/articles/14700000000006-starshipit-wms-products-and-inventory-configuration)
* [Maintain stock accuracy and make adjustments](/articles/14700000000020-adjust-stock-and-investigate-stock-movements)
---
# Receive stock against a purchase order
URL: https://support.starshipit.com/articles/14700000000008-receive-stock-against-a-purchase-order
Canonical: https://support.starshipit.com/articles/14700000000008-receive-stock-against-a-purchase-order
Markdown: https://support.starshipit.com/articles/14700000000008-receive-stock-against-a-purchase-order.md
Updated: 2026-09-04
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Record incoming deliveries against purchase orders using desktop or mobile, with support for batch, serial, partial, and quality-control receipts.
**Receiving** is the process of recording what physically arrives from your suppliers and bringing it into WMS inventory. When you complete a receipt, WMS:
* Records the quantities, batch numbers, serial numbers or expiry dates (where applicable).
* Adds the stock to your chosen location.
* Updates **Incoming** and **On hand** figures on the inventory dashboard.
* Writes a stock movement record for full audit history.
Receiving is tied to a purchase order. This lets WMS compare what you ordered against what actually arrived, flagging shortages or over-deliveries.
## Before you start
* You need a purchase order with status **CREATED** or **PARTIALLY_RECEIVED**. See [Suppliers and purchase orders](/articles/14700000000007-suppliers-and-purchase-orders) if you have not yet created one.
* Know which location(s) you will receive into — a staging dock, Quality Control, or a final storage location.
* Review the **Over-Receiving Tolerance** and **Under-Receiving Tolerance** under **System > Settings > Receiving** before accepting a supplier over-delivery or closing a short purchase order.
## Starting a receiving session
**On desktop:**
1. Open a PO with status **CREATED**, then select **Receive Goods**. You can also open **Receive goods** from the dashboard and select a **CREATED** or **PARTIALLY_RECEIVED** PO.
2. Review the list of PO lines and expected quantities.
**On mobile:**
1. Open **Actions > Receive PO** in the WMS mobile app.
2. Select the PO you want to receive against.
3. Select a PO line by searching or scanning a barcode.
## Entering received quantities
For each line on the PO, enter the actual received quantity. This can be less than the ordered quantity. The **Over-Receiving Tolerance** sets the maximum percentage above each ordered line quantity that workers can receive. A `0%` tolerance prevents extra units. Some accounts may show an unlimited legacy setting until an admin saves a finite percentage.
**For Batch-tracked products:**
* Enter the batch or lot number.
* Optionally record an expiry date.
**For Serial-tracked products:**
* Enter one serial number per unit received.
* Receiving a quantity higher than the number of serials entered will raise a warning — WMS requires a serial for every unit.
**For Standard-tracked products:**
* Enter the quantity received. No additional identifiers are required.
WMS validates that all required tracking information is provided before you can complete the receipt.
Use the quantity controls to increase, decrease, or enter the quantity for each line. **Receive all remaining** fills the outstanding quantities for lines that are ready. For batch- or serial-tracked products, complete the required tracking details first; WMS keeps the bulk action unavailable while those details are missing.
The desktop receiving screen keeps the expected quantity, quantity being received, destination and tracking requirements together for each PO line.
Receiving drafts are saved while you work, so you can leave and return to a receive-goods session without losing entered quantities. Always review the draft before submitting if another team member may have continued the receipt.
### Recording inbound cartons
When **Enable Cartons Received** is turned on under **System > Settings > Receiving**, you can record the number of inbound cartons delivered for the purchase order. This optional value is captured on the receipt and included in the **PO Receipt Report** CSV export, which is useful for reconciling freight invoices or tracking carton accuracy.
## Choosing a destination
For each line, choose where the received stock should go:
* **A final storage location** (pick face, bulk storage) — WMS adds the stock directly there. No separate putaway job is created. This is called *direct putaway*.
* **A staging dock** — WMS creates a putaway job so you can move the stock to its final location later.
* **A Quality Control location** — WMS holds the stock for inspection and keeps it unavailable for picking. Create a putaway job when the approved products and quantities are ready to move into storage.
The receiving screen shows the location marked as the default stocktake and receiving location. The default can be a **Pick Face**, **Bulk Storage**, **Staging/Receiving Dock**, or **Quality Control** location. You can select another available location for a line. If the wrong location is pre-selected, update the default on the location record before receiving again.
See [Putaway](/articles/14700000000009-putaway) for how staged stock is moved to final locations.
## Receiving on mobile
The WMS mobile app supports full PO receiving from the warehouse floor, including barcode scanning for PO lines and locations:
1. Open **Actions > Receive PO**.
2. Select the PO.
3. Select the PO line (by search or barcode scan).
4. Select the receiving location.
5. Enter received quantity and any required tracking details (batch, serial, expiry).
6. If **Enable Cartons Received** is on, enter the cartons delivered.
7. Submit the receipt.
This gives the same result as desktop receiving, reducing paper and avoiding walk-backs to a workstation.
## After receiving
Once a receipt is submitted:
* **Direct putaway**: Stock is immediately available at the destination location and can be allocated to orders.
* **Staged receiving**: Stock appears in the staging location. You will need to complete the putaway job before the stock is in a pick-face or bulk location available for picking.
* **Quality Control receiving**: Stock remains unavailable while it is inspected. Create and complete a putaway job to release approved stock into a pick face or bulk location.
* **Webhook notification**: If WMS webhooks are enabled, a stock-received event can be sent after receiving completes.
You can verify the receipt using:
* The **Inventory dashboard** — to see updated on-hand quantities.
* **Location view** — to confirm which products are at each location.
* **Stock movement logs** — to see the RECEIVE movement recorded against the PO.
## FAQ
Do I have to receive against a purchase order?
Using POs is strongly recommended. POs make it easier to reconcile ordered vs received quantities and keep Incoming figures accurate. If you receive ad-hoc stock without a PO, use a manual stock adjustment to bring it into inventory — but note this creates less traceability than a proper receipt.
What happens if I receive more than ordered?
WMS records the extra quantity. You can decide whether to amend the PO to reflect the over-delivery or treat it as an unplanned receipt. The PO status will move to RECEIVED once you mark it as complete.
WMS prevents a line from exceeding its configured **Over-Receiving Tolerance**. Ask an admin to review **System > Settings > Receiving** if your warehouse needs to accept a larger supplier over-delivery.
What happens if I receive less than ordered?
The PO status stays **PARTIALLY_RECEIVED** until the remaining quantity arrives. If you deliberately mark the PO complete, WMS checks the **Under-Receiving Tolerance** against every line. A line below the allowed percentage remains open and WMS tells you the minimum quantity required. See [Suppliers and purchase orders](/articles/14700000000007-suppliers-and-purchase-orders).
Can I receive without choosing a final location?
Yes — receive into a **Staging Dock** location. WMS will create a putaway job so you can move stock to final locations later. This is useful for large or mixed deliveries where you want to log everything quickly and sort it afterwards.
---
# Manage suppliers and purchase orders
URL: https://support.starshipit.com/articles/14700000000007-manage-suppliers-and-purchase-orders
Canonical: https://support.starshipit.com/articles/14700000000007-manage-suppliers-and-purchase-orders
Markdown: https://support.starshipit.com/articles/14700000000007-manage-suppliers-and-purchase-orders.md
Updated: 2026-08-17
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Create and manage suppliers and purchase orders in Starshipit WMS to track incoming stock and drive your receiving workflow.
Before stock can be received into your warehouse, you need two things in Starshipit WMS: a **supplier** record for each vendor you buy from, and a **purchase order (PO)** for each incoming delivery. Add a supplier email when you want to send a created PO directly from WMS.
Suppliers and POs give you:
* A structured record of what you ordered, from whom, and in what quantity.
* Visibility of **Incoming** stock on the inventory dashboard before it physically arrives.
* A receiving workflow that compares what you expected against what actually arrived.
## Suppliers
Suppliers represent the vendors or manufacturers you purchase stock from. Setting them up first makes it easier to create purchase orders and report on inbound stock by supplier.
### Creating a supplier
1. Go to the **Suppliers** section in WMS.
2. Click **Create supplier**.
3. Enter the supplier name.
4. Enter an email address if you want to send purchase orders to this supplier from WMS.
5. Click **Save**.
You can edit supplier details at any time. Each purchase order is linked to a supplier record, giving you a clear history of who supplied each delivery.
## Purchase orders
A **purchase order (PO)** represents a delivery of stock you have ordered and expect to receive. In WMS, POs:
* Record what has been ordered from each supplier
* Drive the receiving process when stock arrives
* Update the **Incoming** quantity for each product on the inventory dashboard
### Creating a purchase order
1. Go to the **Purchase Orders** section.
2. Click **Create purchase order**.
3. Select a **Supplier**.
4. Enter a **PO number** (your internal reference or the supplier's order number).
5. Add line items:
* Select each product (SKU) you are ordering.
* Enter the ordered quantity.
* Optionally add cost or pricing details for reference.
6. Save as **DRAFT** if you are still editing, or set to **CREATED** when confirmed.
### Email a purchase order
You can email a purchase order after it has status **CREATED** and its supplier has an email address.
1. Go to **Purchase Orders** and open the created purchase order.
2. Check the supplier, line items, quantities, pricing and delivery details.
3. Confirm the **Supplier Email** is correct. If it is missing, open the supplier record and add it.
4. Click **Email Supplier**.
WMS confirms the email has been queued and shows the recipient address. Draft purchase orders cannot be emailed.
Use the purchase order list to compare suppliers, statuses, expected dates, line counts and received quantities before opening a PO.
The PO detail page shows the supplier, expected date, line items, unit costs and totals that should be checked before receiving.
### Duplicate a purchase order
Use **Duplicate** from a purchase order's actions menu when you need another order with the same supplier, expected arrival date, products, quantities and prices. WMS creates a new draft and adds the next available numeric suffix to the original PO number, such as `PO-100-1`.
Review and edit the new draft before changing its status to **CREATED**.
### Import purchase orders
If you need to create many POs at once — for example, when migrating from another system — you can import them via CSV upload. Your CSV must follow the required column structure for PO number, supplier, and line items.
If Unleashed or MYOB Acumatica is connected, open the purchase-order actions menu and select **Import from Unleashed** or **Import from MYOB Acumatica**. Preview the available purchase orders, select the ones you need, then choose whether WMS should create them as **Draft** or **Created**.
For MYOB Acumatica prerequisites, product matching and verification, see [Set up MYOB Acumatica with Starshipit WMS](/articles/14700000000056-set-up-myob-acumatica-with-starshipit-wms).
### PO statuses
Purchase orders move through the following statuses:
| Status | What it means |
|---|---|
| **DRAFT** | PO is being prepared and has not yet been issued. |
| **CREATED** | PO has been issued and is awaiting receipt. |
| **PARTIALLY_RECEIVED** | Some lines or quantities have arrived; more are still expected. |
| **RECEIVED** | All lines and quantities have been fully received. |
The status updates automatically as you receive stock against the PO.
### Handling incomplete or short deliveries
If a supplier ships less than expected, the PO stays in **PARTIALLY_RECEIVED** until the remaining quantity arrives.
If you decide you will not receive the outstanding quantity, you can:
* **Mark individual lines as missing** — records that the expected stock did not arrive.
* **Mark the PO as fully received** — closes the PO and removes it from your outstanding view, even if not all lines have been received. Use this when you have decided not to follow up on the remaining quantity.
### Monitoring outstanding POs
Regularly review POs with status **CREATED** or **PARTIALLY_RECEIVED** to follow up on short deliveries or delayed shipments. The PO list supports filtering by status so you can focus on what is still outstanding.
## Next steps
* [Receiving stock](/articles/14700000000008-receiving-stock) — how to receive a delivery against a PO.
* [Putaway](/articles/14700000000009-putaway) — how to move received stock from staging to final storage locations.
---
# Put away received stock
URL: https://support.starshipit.com/articles/14700000000009-put-away-received-stock
Canonical: https://support.starshipit.com/articles/14700000000009-put-away-received-stock
Markdown: https://support.starshipit.com/articles/14700000000009-put-away-received-stock.md
Updated: 2026-08-20
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Move received stock from staging docks to final warehouse locations using putaway jobs on desktop or mobile.
**Putaway** is the process of moving received stock from a staging area to its final storage location — such as a bulk shelf or a pick face.
When you receive a delivery into a **Staging Dock**, WMS automatically creates one or more putaway jobs to complete the placement. This two-step workflow (receive, then put away) lets your receiving team log deliveries quickly without needing to know final locations at the time of receipt.
If you receive stock directly into a final location (direct putaway), no putaway job is created — the stock is immediately available.
## When to use staging vs direct putaway
| Workflow detail | Direct putaway | Staged putaway |
|---|---|---|
| **How it works** | Receive directly into a pick face or bulk location | Receive into a staging dock; complete putaway separately |
| **Best for** | Small deliveries, known locations, fast-moving SKUs | Large or mixed deliveries, separate receiving and putaway teams, new SKUs |
| **Putaway job created** | No | Yes |
| **Stock available for picking** | Immediately | After putaway is completed |
## Choose how WMS assigns destinations
Staged putaway jobs use one of two destination modes. **Advisory** is the default. **Enforced** gives workers a planned route and requires them to use the destinations assigned by WMS.
| Destination behavior | Advisory | Enforced |
| --- | --- | --- |
| **Destination choice** | WMS suggests locations, but the worker chooses any valid destination. | WMS assigns each line to a valid destination. |
| **Capacity** | Capacity can appear as a warning, but the worker can still choose the location. | WMS reserves destination capacity and checks it again when stock is placed. |
| **Route** | The worker chooses which item and destination to complete next. | The worker gathers the planned load, then places it in the configured location sequence. |
| **If a destination cannot be used** | Choose another valid location. | Select **New location** to ask WMS to replan the line. |
:::note
Changing the destination mode applies to new putaway jobs only. Existing jobs keep the mode they were created with.
:::
## Turn on enforced putaway
### Before you begin
* Configure the storage locations that WMS can use for putaway. Add capacities and location sequences where required.
* Configure at least one **Equipment** location, such as a trolley or cart.
* If your job interface requires scanning, add readable barcodes to products, source locations and destination locations.
### Enable enforced putaway
1. Go to **System > Settings**.
2. Under **Operations**, select **Putaway**.
3. Turn on **Enforce Putaway Locations**.
4. Create a staged putaway job.
5. Open the job and confirm that it shows **Enforced destinations** and a **Putaway Route**.
For 3PL stock, WMS only offers equipment that can accept the clients in the job. Use empty or same-client equipment, or allow mixed-client stock on an equipment location.
## Working a putaway job
### Complete an advisory putaway job
1. Go to the **Putaway** section in WMS.
2. Select a job linked to a staging location or PO.
3. Review the list of items and quantities currently in staging.
4. For each item:
* Review the planned allocation or choose the target location (bulk, pick face, or other).
* Optionally split quantities across multiple locations — for example, send some units to bulk storage and some to the pick face.
5. Complete the job to move stock out of staging into the final locations.
The putaway job shows the staged quantity, suggested destination and any batch or expiry details that must stay with the stock movement.
### Complete an enforced putaway route
1. Go to the **Putaway** section in WMS.
2. Open a job marked **Enforced destinations**.
3. Select the equipment you will use to collect the stock. WMS locks that equipment to the job after gathering starts.
4. Follow the planned lines and gather each item from staging onto the equipment.
5. Follow the route to the next assigned destination.
6. Scan or confirm the destination, then place the item.
7. Repeat the destination and placement steps until the job is complete.
Select **New location** if the assigned destination cannot be used. WMS assigns another valid destination and updates the remaining route. You cannot choose an arbitrary destination in enforced mode.
When a putaway job is completed, WMS:
* Reduces the quantity in the staging location.
* Increases on-hand stock at the destination location(s).
* Records **PUTAWAY** stock movement entries.
### Putaway job statuses
Putaway jobs move through statuses — Pending, Assigned, In Progress, and Completed — so supervisors can see at a glance which deliveries are actively being put away versus waiting to be started.
Putaway jobs are available from the jobs navigation, and long putaway jobs are paginated so large inbound receipts remain workable. If a receipt contains many lines, complete the visible pages in order and confirm the final job summary before closing the job.
### Putaway on mobile
The WMS mobile app supports both destination modes. Advisory jobs let the worker select each item and destination. Enforced jobs guide the worker through the planned gather and placement route.
See [Put away and replenish stock in WMS Mobile](/articles/14700000000027-putaway-and-replenishment-on-mobile) for the mobile steps.
## Create a putaway job manually
You can also create a putaway job from the **location detail view**:
1. Open the location that has stock you want to move (for example, a staging dock).
2. Use the **Create Putaway Job** action.
3. Select the inventory records that are ready to move.
4. Enter the quantity to put away for each selected record. You cannot select more than the available quantity.
5. Review the product and unit totals, then select **Create Job**.
Unselected stock and quantities remain at the source location. This is useful when only part of a staged delivery or Quality Control receipt is ready to move, as well as for clearing receiving docks or moving orphaned inventory that arrived through a non-standard process.
## Verifying putaway
After putaway is complete, confirm the stock is in the right place using:
* **Location view** — select the destination location to see all products and quantities stored there.
* **Inventory dashboard** — check that on-hand quantities have updated correctly for the received SKUs.
* **Stock movement logs** — locate the RECEIVE and PUTAWAY entries for the PO to verify the full inbound trail.
## Troubleshooting enforced putaway
### No destination is available
Check that at least one valid storage location has enough capacity for the stock. If the job interface requires scanning, the destination must also have a barcode.
### No equipment is available
Add an **Equipment** location. For client-owned stock, use equipment that is empty, already contains stock for the same client, or allows mixed-client stock.
### The assigned destination cannot be used
Select **New location** on the planned line. WMS recalculates the destination and refreshes the remaining route.
## Best practices
* **Receive into staging for large or complex deliveries.** Let the receiving team log quantities quickly, then have a dedicated putaway run to sort and move stock efficiently.
* **Standardise destination rules for common SKUs.** Identify which products go to bulk and which go straight to pick faces, and brief your team so putaway is consistent.
* **Complete putaway promptly.** Stock in staging is not typically available for picking. Delays in putaway can affect order allocation and fulfilment times.
* **Monitor PARTIALLY_RECEIVED POs.** Stock may be in staging or awaiting putaway. Regularly review partial receipts to ensure nothing is forgotten.
## Related guides
* [Receiving stock](/articles/14700000000008-receiving-stock)
* [Suppliers and purchase orders](/articles/14700000000007-suppliers-and-purchase-orders)
* [Locations and warehouse setup](/articles/14700000000033-starshipit-wms-locations-and-warehouse-setup)
* [WMS settings reference](/articles/14700000000031-wms-settings-reference)
---
# Automate warehouse work in WMS
URL: https://support.starshipit.com/articles/14700000000039-automate-warehouse-work-in-wms
Canonical: https://support.starshipit.com/articles/14700000000039-automate-warehouse-work-in-wms
Markdown: https://support.starshipit.com/articles/14700000000039-automate-warehouse-work-in-wms.md
Updated: 2026-09-14
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Create WMS automations to manage order holds, release new orders, assign jobs, and build scheduled pick batches with safe filters, timing, and monitoring.
Use Starshipit WMS automations to apply order holds, release eligible orders, assign ready jobs, or create pick batches without repeating the same warehouse task manually.
:::important
WMS automations are warehouse workflows inside Starshipit WMS. They are separate from shipping automations configured in Starshipit.
:::
## Before you begin
- Make sure orders are importing from Starshipit into WMS.
- Open **System > Roles & Permissions** to confirm your access.
- For order holds, add or activate a hold reason under **System > Settings > Orders > Order Hold Reasons** before creating the automation.
- For automatic batches, make sure your Starshipit account has a recognised timezone. WMS uses this timezone for the operating window.
| Task | Required WMS permissions |
|---|---|
| View **System > Automations** | **Settings view** |
| Create, edit, enable, or pause an order hold | **Settings management** |
| Create, edit, or enable automatic release or hold release | **Settings management** and **Fulfillment management** |
| Pause automatic release or hold release | **Settings management** |
| Create, edit, enable, or pause automatic batches | **Settings view** and **Fulfillment management** |
| Create, edit, enable, or pause automatic job assignment | **Settings management** and permission to assign jobs |
## Understand when automations run
WMS supports six automation recipes. Only active recipes can start new runs.
| Recipe | When WMS evaluates it | Result |
|---|---|---|
| **Hold orders by tag or SKU** | At import and on early order updates received within five minutes of import | Places a matching pending order on hold once per recipe |
| **Release hold when tag is removed** | When an upstream order update confirms the configured tag is absent | Removes a hold placed by the matching tag automation; the order stays pending |
| **Release stocked order holds** | When the scheduled automation checks stock availability | Removes an eligible system-created hold when the full order is allocatable; the order stays pending |
| **Auto-release new orders** | Once, after a new order notification imports the order into WMS | Fully allocates and releases an eligible pending order to picking |
| **Create automatic batches** | Repeatedly during the daily operating window | Groups eligible pending orders into pick batches |
| **Assign ready jobs** | When the scheduled automation checks for eligible work | Assigns an eligible ready, unassigned job to the least-loaded selected person |
Order hold recipes run first. If a hold recipe matches, it takes precedence over automatic order routing and automatic release. If no hold recipe matches, automatic order routing takes precedence over automatic release.
Enabling a hold recipe does not scan existing orders. It can match a pending order on an early update received within five minutes of its WMS import, including a tag that arrives after import. Later updates do not start a new hold run. Automatic release remains a one-shot new-order recipe. Automatic batches and stock-based hold release can consider existing eligible pending orders during their scheduled checks.
## Create an automation
1. Go to **System > Automations**.
2. Select **New automation**.
3. Select a **Recipe**.
4. Enter a clear **Name** that identifies the workflow.
5. Configure the recipe settings.
6. Leave **Enable after saving** off if you want to review or test the configuration first.
7. Select **Save automation**.
The automation appears as **Active** or **Paused** on the Automations dashboard.
## Configure each recipe
### Hold orders by tag or SKU
Use this recipe for orders that should not enter fulfilment immediately, such as pre-orders or orders that require review.
1. Select **Tag** or **SKU** under **Condition**.
2. Enter the exact **Order tag** or **Order SKU** to match. A SKU condition holds the whole order when any line item has that SKU.
3. Select an active **Hold reason**.
4. Choose whether to enable the automation after saving.
Tag and SKU matching is exact and case-insensitive. Choose one condition per recipe. For example, `Pre-Order` matches `pre-order`, but it does not match `pre-order-july`.
WMS can apply the hold at import or on an early order update received within five minutes of import, while the order is still pending. The window uses the time WMS received the update, so queue delays do not extend it. Releasing a hold later does not cause the same recipe to apply it again. If the configured hold reason becomes inactive, the automation needs attention and cannot be enabled again until you select an active reason.
### Release hold when tag is removed
Use this recipe when removing an upstream order tag should clear the hold that the matching tag automation placed.
1. Select **Release hold when tag is removed** as the recipe.
2. Enter the exact **Order tag** used by the hold automation.
3. Choose whether to enable the automation after saving.
When WMS receives an upstream order update confirming that the tag is absent, it removes the matching automation-created hold from the pending order. Matching is exact and case-insensitive. Manual holds, SKU-based holds, and holds from another tag are not released by this recipe.
The order stays **Pending**. Removing the hold does not allocate stock or send the order to picking. To verify the recipe, remove the tag from a test order held by the matching automation, wait for the update to reach WMS, then check the hold and **Latest run**.
### Release stocked order holds
Use this recipe to remove a stock-related hold when the full order can be fulfilled from allocatable pick-face stock.
1. Select **Release stocked order holds** as the recipe.
2. Select the active **Hold reason** used for the system-created holds you want to release.
3. Choose whether to enable the automation after saving.
WMS checks pending orders with system-created holds using that reason. Manual holds are not eligible. The full order must be allocatable; insufficient stock or required kitting keeps the hold in place.
After the hold is removed, the order stays **Pending**. This check does not reserve stock or release the order to picking. Verify the recipe with a test order by making enough pick-face stock available, then check the hold and **Latest run** after the scheduled check.
### Auto-release new orders
Use this recipe when eligible new orders should move directly from **Pending** to picking.
1. Enter an **Order tag** to limit the recipe, or leave it blank to match every new order notification.
2. Choose whether to enable the automation after saving.
An order is released only when WMS can allocate the full order. The order stays **Pending** when it:
- Has an active hold.
- Does not have enough pick-face inventory.
- Can only be partially allocated.
- Requires kitting.
- Is no longer pending when the automation runs.
Automatic release is a one-shot recipe. WMS does not check the order again after stock or order conditions change. Resolve the issue, then release the order manually if it is ready.
:::important
You cannot enable automatic release while automatic order routing is enabled for the account. If routing is enabled after an automatic-release recipe is active, the recipe shows **Waiting for routing** and does not run.
:::
### Assign ready jobs
Use this recipe to distribute ready, unassigned work across a selected group without assigning each job manually.
1. Select the **Job types** that the automation can assign.
2. Select the eligible **Roles**.
3. Under **Available for assignment**, select the active users who can receive work.
4. Optionally set **Maximum unfinished jobs per user** to stop the automation assigning more work to someone who has reached their capacity.
5. Choose whether to enable the automation after saving.
When the automation runs, WMS checks the selected user's client access and job permissions, then assigns work to the least-loaded eligible person. If no selected person is available, or everyone has reached the maximum unfinished-job limit, the job stays unassigned.
### Create automatic batches
Use this recipe to build pick batches from fully allocatable pending orders during a defined daily window.
| Setting | How it works |
|---|---|
| **Batch name prefix** | Optional text added to generated batch names so teams can recognise the workflow that created them |
| **Carrier** | Optional exact match against the carrier code or display name |
| **Service code** | Optional exact match against the carrier service code |
| **Order tag** | Optional exact tag match |
| **Order number condition** and **Order number prefix** | Choose **Starts with** or **Does not start with** to filter by the entered prefix. Matching ignores letter case and treats the prefix as literal text; orders without an order number are excluded when this filter is set |
| **Minimum total quantity (optional)** and **Maximum total quantity (optional)** | Inclusive limits on the sum of item quantities per order; enter whole numbers from 1 to 1,000,000, or leave either limit blank |
| **Target batch size** | Creates full batches when this many eligible orders are ready; enter 2 to 100 |
| **Maximum wait (minutes)** | Creates a smaller batch after the oldest eligible order has waited this long; enter 1 to 1,440 |
| **Window starts** and **Window ends** | Defines the daily period when WMS can create batches; both times must be on the same day |
| **Timezone** | Uses the timezone from your Starshipit account when you create the recipe |
Filled filters are combined, so an order must match every filter you enter. Carrier, service code and order tag filters use exact, case-insensitive matching. Quantity limits apply to each order, not to the total batch. For example, set both limits to `1` to batch single-unit orders.
During the operating window, WMS checks the recipe about once a minute. It creates full batches as soon as the target size is available. If fewer orders are ready, it waits until the oldest eligible order reaches the maximum wait, then creates a smaller batch.
Only pending orders without an active hold are considered. Each order must have enough stock for full allocation. Held, unallocatable, and non-matching orders remain pending for a later check.
## Review run history and outcomes
The **Latest run** column shows the most recent recorded run for each automation. Select the linked order, batch, or job to investigate the outcome. You need fulfilment view access to see these links.
| Latest run | What it means |
|---|---|
| **Never run** | No matching new-order recipe has acted yet, an automatic batch has not had a group ready to create, or no ready job has been assigned |
| **Run queued** | WMS has queued the run, including a retry when a temporary error occurred |
| **Running** | The action is in progress |
| **Last run succeeded** | WMS placed the hold, released the order, created the batch, or assigned the job |
| **Last run skipped** | The recipe matched, but the order or job could not be acted on, such as when it was already held, lacked stock, was no longer pending, or no eligible person was available |
| **Last run failed** | WMS could not complete the action |
The outcome below the status explains common results, such as insufficient pick-face stock, partial allocation, an existing hold, or a created batch. A scheduled batch check that is still waiting for enough eligible orders does not create a run, so **Latest run** may remain unchanged.
Use the **Needs attention** filter to find automations with a skipped or failed latest run, an inactive hold reason, or an automatic-release conflict with routing.
## Test and roll out safely
1. Save the automation with **Enable after saving** off.
2. Review the recipe name, filters, permissions, hold reason, and timing.
3. For automatic release or automatic batches, add a unique test tag so the first run affects only test orders. For automatic job assignment, select a small test group and one job type.
4. Create a test order that will not be shipped to a customer. Make sure it has the expected tag or SKU for the hold condition, or the tag and pick-face stock needed for automatic release or batching.
5. Enable the automation, then import the test order. For an automatic batch, run the test during its operating window and use a small target size. For automatic job assignment, create or release a test job and confirm it is assigned to the expected person.
6. Check **Latest run**, its outcome, and the linked order or batch.
7. Pause the automation before widening its filters or removing the test tag.
8. Re-enable it when the production configuration has been reviewed.
Avoid overlapping recipes that can match the same order. If multiple hold recipes match, the first can place the hold while later recipes are skipped. If multiple automatic-release recipes match, one can release the order while later recipes find that it is no longer pending.
## Pause or change an automation
Use the switch in the **Actions** column to move an automation between **Active** and **Paused**. Select **Edit** to change its name or configuration.
Pausing prevents new matches or scheduled checks from starting. It does not undo holds, releases, allocations, or batches already created. A run that is already queued or in progress may still finish.
When you re-enable an order hold recipe, it can match later imports or eligible early updates. Re-enabling automatic release applies only to later new-order notifications. Tag-based hold release waits for an upstream order update, while stock-based hold release checks eligible existing holds on its next scheduled run. When you re-enable an automatic batch, WMS can consider existing eligible pending orders during the next operating-window check. When you re-enable automatic job assignment, WMS can consider eligible ready, unassigned jobs during its next scheduled check.
## Troubleshooting
| Problem | What to check |
|---|---|
| You cannot open **Automations** | Confirm your role has settings view access. |
| **New automation** or a recipe is unavailable | Check the required permissions. For holds, add an active hold reason. For batches, confirm the Starshipit account timezone is available. |
| A hold was not applied | Confirm the recipe was active, the order was pending, and the tag or SKU matched at import or on an update received within five minutes of import. Matching is exact and case-insensitive. |
| A tag-based hold was not released | Confirm an upstream update reached WMS without the configured tag, the order is pending, and the active hold came from the matching tag automation. Manual and SKU-based holds are excluded. |
| A stock-based hold was not released | Confirm the hold is system-created with the selected active reason, and the full pending order has enough allocatable pick-face stock without requiring kitting. |
| Automatic release did not run | Check for a matching hold recipe, automatic order routing, the optional tag filter, and whether the order came from a new-order notification. |
| Automatic release was skipped | Review the outcome for a hold, insufficient pick-face stock, partial allocation, kitting, or a changed order status. Fix the condition and release the order manually. |
| An automatic batch was not created | Confirm the current time is inside the operating window. Check that enough pending orders match every filter, have no hold, and can be fully allocated. If the target size is not ready, WMS waits for the maximum wait. |
| An automation shows **Needs attention** | Review **Latest run** and its outcome. Also check for an inactive hold reason or an automatic-release conflict with routing. |
| A tag or carrier filter matched no orders | Remove extra spaces and compare the complete value. Matching ignores case but does not match partial text. |
| A ready job was not assigned | Confirm the recipe is active, the job type is selected, the job is unassigned and ready, and at least one selected user has the required role, permissions, client access, and remaining capacity. |
## Related articles
- [Starshipit WMS orders and allocation](/articles/14700000000010-starshipit-wms-orders-and-allocation)
- [Picking orders](/articles/14700000000011-picking-orders)
- [WMS settings reference](/articles/14700000000031-wms-settings-reference)
---
# Manage orders and allocation in WMS
URL: https://support.starshipit.com/articles/14700000000010-manage-orders-and-allocation-in-wms
Canonical: https://support.starshipit.com/articles/14700000000010-manage-orders-and-allocation-in-wms
Markdown: https://support.starshipit.com/articles/14700000000010-manage-orders-and-allocation-in-wms.md
Updated: 2026-09-14
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Learn how orders flow from Starshipit into WMS, how stock allocation works, and how to release orders for picking and packing.
Most orders flow automatically from your ecommerce store into Starshipit. From there, Starshipit WMS picks them up and makes them ready for your warehouse team to fulfil. You can also create an order manually or import orders from CSV when they do not come from a connected store.
**The order journey:**
1. **Customer places an order** in your ecommerce platform (Shopify, WooCommerce, etc).
2. **Order appears in Starshipit** via your ecommerce integration.
3. **WMS picks up the order automatically.** It appears in your WMS orders dashboard with status **Pending**.
4. **You release the order** when ready. WMS allocates stock and creates pick jobs for your team.
5. **Your team picks, packs and ships.** Labels are printed in Starshipit.
6. **WMS confirms shipment** and finalises stock movements.
WMS also stays in sync with Starshipit when orders change - if an order is edited, cancelled, or shipped in Starshipit, WMS updates automatically.
:::note
Orders typically appear in WMS within a few seconds of being created or updated in Starshipit.
:::
## Order statuses
| Status | What it means |
|---|---|
| **Pending** | Order has arrived in WMS and is awaiting release to the warehouse. |
| **Released** | Order has been released; stock is allocated and pick jobs are created. |
| **Partially Shipped** | Some items have shipped; others are still outstanding. |
| **Shipped** | Order has been fully shipped. |
## Orders dashboard
The orders dashboard gives you a live view of everything in the fulfilment queue:
* **Status filters** - filter by one or more statuses at once (e.g. show Pending and Released together).
* **Insufficient inventory warning** - orders where stock is short are flagged with a warning icon so you can identify and act on shortfalls immediately.
* **Allocatable-only filter** - shows only orders that can be fulfilled right now, hiding anything blocked by stock shortfalls.
* **SLA and address signals** - show order service-level timing and Starshipit address validation details where available.
* **Select all** - applies to your currently filtered results only, so bulk actions only affect the orders you can see.
* **Put on hold** - quickly pause an order so no further outbound work happens on it.
* **Order tagging** - bulk-apply Starshipit tags to selected orders directly from WMS.
* **Archive or delete actions** - remove orders from active Starshipit order views when your workflow calls for cleanup.
* **Order barcode printing** - print one sales-order-number barcode from a row action or labels for up to 100 selected orders.
* **Order detail view** - open any order to see a full timeline of events, stock movements, and processing history.
* **Merged-order history** - expand an order that Starshipit created by merging several orders to see the original order numbers.
* **Pending-order editing** - correct the receiver address, products, or quantities before warehouse work starts.
You can create a manual order in WMS when a warehouse team needs to process one order that did not arrive through the usual ecommerce flow. Use the CSV import when you need to submit several orders together.
## Import orders from CSV
Use the order CSV import for offline, wholesale, or other orders that are not supplied by a connected store.
1. Open the **Orders** dashboard and select **Import CSV**.
2. Select **Download CSV Template**.
3. Add the destination and product details. Use one row for each order line, and repeat the same order reference for lines that belong to one order.
4. Return to **Import CSV** and select the Starshipit account that should own the orders.
5. Select the completed CSV file, then select **Import Orders**.
6. Review the submitted and failed totals. If an order fails, create a new CSV containing every row for only that failed order reference, correct the reported issue, and import the retry file. Do not re-import order references that were already submitted.
Each import can contain up to 50 orders, 1,000 line items, and a 1 MB file. WMS submits each valid order to the selected Starshipit account, then processes it back into WMS through the normal order flow.
## Edit a pending order
Edit an order in WMS before releasing it when you need to correct its receiver address, products, or quantities.
Before you begin, you need permission to manage fulfilment. The order must still be **Pending** in WMS and unshipped in Starshipit, with no shipped quantity. Inter-warehouse transfer orders cannot be edited.
1. Open the **Pending** order from the Orders dashboard.
2. Select **Edit Order**.
3. Update the receiver address or order items.
4. Select **Save Changes**.
5. Wait for the order to sync back from Starshipit, then confirm the updated details before releasing it.
Carrier and packaging details are selected during packing, not in this editor.
If the order changes after you open the editor, WMS preserves the newer version. Reload the order and apply your changes again.
## Check addresses before release
Review address validation while an order is **Pending**, before releasing it for allocation and picking.
To resolve one order:
1. Find the address validation status beside the order number, or open the order's actions menu and select **Resolve Address**.
2. Review the original address and the suggestions returned by Starshipit.
3. Click **Apply suggestion** beside the correct address.
4. Confirm the order now shows a valid address before releasing it.
To refresh validation information for several orders, select the pending orders and click **Refresh Live Data**. This updates the Starshipit data shown in WMS, including address validation status where available.
:::important
WMS does not bulk-apply address corrections. After refreshing several orders, resolve each invalid address individually so you can review the proposed change before it is saved.
:::
## Releasing orders
Orders start as **Pending** and have no stock committed until you release them. This gives you control over when your warehouse starts working on each order.
### Release a single order
1. Open the **Orders** dashboard.
2. Select a **Pending** order.
3. Click **Release**.
WMS checks available inventory, allocates stock, and creates a pick job.
### Release orders in bulk
Use the checkboxes to select multiple orders, then choose **Release selected**. The **allocatable-only filter** is useful here - apply it first so you're only releasing orders that actually have stock.
Bulk release is ideal for end-of-day waves, courier cut-off runs, or batches grouped by sales channel.
## How WMS allocates stock
When you release an order, WMS automatically reserves the right stock for each line item. This is called **allocation**.
WMS follows the rules configured on each product to decide what to reserve:
* Automatic allocation uses **pick face** stock. If a pick face is low, replenish it before automatic release.
* When manually selecting inventory for an order, you can also choose eligible **bulk storage** stock. WMS uses only the bulk inventory you explicitly select; it does not automatically fall back to other bulk stock.
* For batch or serial tracked products, allocation locks in the specific batch or serial number.
* The allocation strategy (FIFO, FEFO, etc.) on each product determines which units are reserved when multiple options exist.
See [Products and inventory configuration](/articles/14700000000006-starshipit-wms-products-and-inventory-configuration) for how to configure these rules, and [Replenishment](/articles/14700000000016-replenishment) for how pick face restocking works.
Use the allocations view to inspect the exact product, location, batch, quantity, order and job behind each active reservation.
### When an order can't be fully allocated
If there isn't enough stock, WMS flags the order with a warning rather than processing it silently. Your options:
* Wait for incoming stock (visible on your inventory dashboard when a purchase order is in progress).
* Edit an eligible **Pending** order in WMS to adjust or substitute items. For other order states, make the change in Starshipit.
* Partially ship what's available if your workflow supports it.
Expand the Pending order to review the shortage by SKU. WMS can show the required quantity, the shortfall, pickable stock, earlier pending demand, stock held outside pick faces, and related putaway or replenishment work. Links to product inventory and jobs appear only when your role can open those pages. Use this evidence to decide whether to replenish, finish open warehouse work, wait for incoming stock, or change the order.
## Batch and wave workflows
WMS supports releasing and picking orders in batches - grouping multiple orders into a single run to reduce walking time and speed up fulfilment. These workflows are covered in the [Picking](/articles/14700000000011-picking-orders) and [Expedited fulfilment](/articles/14700000000013-expedited-fulfilment-pack-now-batch-pack-now) guides.
## Routed orders
If your business uses parent and child Starshipit accounts, WMS can help route orders to the right fulfilment location:
* **Automatic routing** assigns eligible imported parent orders to configured child stores.
* **Manual routed-order actions** let authorised users reject pending routed orders or release them back to the parent pool.
* **Store priority and availability** control which stores participate in routing and which store should be preferred first.
Use routing when multiple stores or warehouses share order demand and you want WMS to help decide where an order should be fulfilled. If a store is temporarily unavailable, mark it unavailable instead of removing it from your routing setup.
## Holding and removing orders from outbound
Two actions are useful when an order should stop moving through the warehouse:
* **Put on hold** - use this as a quick pause. It prevents further action on the order.
* **Undo release** - use this when you want to remove the order from outbound work entirely and return it to a pre-release state.
### Put on hold
Putting an order on hold is designed to pause it immediately. This is useful when something needs to be checked before fulfilment continues.
If the order is part of a batch pick or batch pack, putting it on hold can freeze the whole batch. Use it when you genuinely want the whole workflow to pause.
To place a hold on one order:
1. Open the order actions menu and select **Put on hold**.
2. Choose an active **Reason**.
3. Add an **Operator note** if the warehouse team needs more context.
4. Click **Put On Hold**.
The order stays on hold until your team removes it. Release, pick, pack and ship actions are blocked while the hold is active.
### Manage hold reasons
Go to **System > Settings > Orders > Order Hold Reasons** to add a reason code and label, choose its highlight colour, set its display order, or make it active or inactive. The colour appears on held-order badges and rows so teams can distinguish reasons at a glance. Only active reasons can be selected when placing a hold. Built-in reasons cannot be changed or removed.
See the [WMS settings reference](/articles/14700000000031-wms-settings-reference) for the available controls.
### Undo release
If you need to eject one order from outbound work without blocking the rest of the batch, use **Undo release** instead. This removes that order from the active outbound flow so the remaining orders can continue.
To return several released orders to Pending, open the **Released** tab, select the orders, and choose **Undo Release**. WMS shows the result for each order, keeps failed orders selected, and refreshes the table after the bulk action completes.
### Holds dashboard and bulk pre-order holds
The holds dashboard gives supervisors a central place to review orders that are paused before or during fulfilment. Bulk pre-order holds are useful when you need to pause a group of not-yet-ready orders, such as pre-orders waiting on incoming stock or orders awaiting customer confirmation.
To resume several held orders, select up to 100 held orders on the Orders dashboard and choose **Release Hold**. Add an optional release note, then confirm. Orders that are not currently on hold are excluded from this action.
You can also select active holds on the **Order Holds** dashboard and choose **Release Holds**. Selection can span pages; use **Select all matching active holds** to include the filtered results. Bulk release is limited to 100 orders, so narrow the filters if needed. Review the results after confirming: failed orders remain selected for follow-up.
## When orders change or cancel
**Order updates** - You can edit an eligible **Pending** order in WMS, or edit it in Starshipit. WMS submits its editor changes to Starshipit, then receives the updated order through the normal sync. For upstream changes to released orders, existing allocations and pick jobs are cancelled and the order returns to **Pending** for re-release with the correct details.
**Cancellations** - When an order is cancelled in Starshipit, WMS frees the reserved stock and cancels any related pick or pack jobs.
**Shipments** - When a label is printed or an order is shipped in Starshipit, WMS marks the order as **Shipped** (or **Partially Shipped**) and finalises inventory movements.
**Released order sync** - Released orders can refresh from Starshipit so the WMS record stays aligned when an order changes upstream. Review any warning or process-log entries before re-releasing an updated order.
For the complete workflow, including import-status filters, restocking, and fulfilled-order returns, see [Manage order cancellations, refunds and returns in WMS](/articles/14700000000060-manage-order-cancellations-refunds-and-returns-in-wms).
:::important
Use the WMS editor only while an order is **Pending**. If the **Edit Order** action is unavailable, make the change in Starshipit and review the synced order in WMS before continuing fulfilment.
:::
## Manifest shipped orders
Create a Starshipit manifest for orders that have reached **Shipped** or **Partially Shipped** status.
1. Open the **Shipped** tab on the Orders dashboard.
2. Select up to 200 orders from one Starshipit account.
3. Select **Manifest**.
4. Check the manifest status icon beside each order after WMS refreshes the shipped-order data.
WMS downloads the manifest PDF when Starshipit returns one. If Starshipit creates the manifest without returning a PDF, the manifest still succeeds and WMS updates the status after refreshing the orders.
## Check and retry shipment writeback
On the **Shipped** tab, WMS shows each order's manifest and Starshipit writeback status. Use the advanced **Manifest** and **Writeback** filters to find orders that are not manifested or whose writeback failed.
For a failed writeback:
1. Open the order actions menu and select **Retry Writeback**.
2. Wait for Starshipit to process the queued retry.
3. Select **Refresh Status** and confirm the writeback is up to date.
Retry is available only for shipped or partially shipped orders with a current failed writeback status. If it fails again, review the order and process logs before retrying another time.
## Print sales order barcodes
Print the sales order number as a barcode when warehouse paperwork, totes, or staging areas need a scannable order reference.
* Open one order's actions menu and select **Print barcode**.
* To print several, select up to 100 loaded orders and choose **Print Barcodes**.
* Preview the labels and choose sheet, 101 x 48 mm, 57 x 32 mm, or 100 x 50 mm layout before printing.
WMS remembers the selected layout in that browser. Orders without a printable order number are left out.
## FAQ
Do I have to release orders from WMS, or can I just ship from Starshipit?
You can continue shipping from Starshipit without releasing orders in WMS. When the WMS integration is active, it tracks allocations and stock movements in the background. This is sometimes called **headless mode** - WMS manages inventory while Starshipit drives your day-to-day operations. Releasing and using pick jobs is recommended when you want structured warehouse workflows for your team.
What happens if I release an order but never ship it?
The order stays in **Released** with stock reserved against it. If the order is later cancelled in Starshipit, WMS will free that stock and cancel related jobs automatically.
Can I reallocate an order if stock moves or changes?
Yes. Delete the existing allocations from the allocations view, then re-release the order. WMS will recompute allocations based on current inventory.
Should I use Put on hold or Undo release?
Use **Put on hold** when you want to pause the order quickly. Use **Undo release** when you want to remove that order from outbound work and let the rest of the batch continue.
Does WMS allocate from staging locations?
No. Automatic allocation uses pick face locations. Manual inventory selection can also use eligible bulk storage, but staging locations are not allocation sources.
How does allocation handle bundles?
For **exploding bundles**, WMS allocates stock from the component SKUs rather than the bundle SKU itself. For **require stock** bundles, WMS allocates stock against the bundle SKU's own inventory. Behaviour follows the bundle configuration you set in the product record.
---
# Pack and ship orders in WMS
URL: https://support.starshipit.com/articles/14700000000012-pack-and-ship-orders-in-wms
Canonical: https://support.starshipit.com/articles/14700000000012-pack-and-ship-orders-in-wms
Markdown: https://support.starshipit.com/articles/14700000000012-pack-and-ship-orders-in-wms.md
Updated: 2026-09-14
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Verify picked items, pack parcels, and generate shipping labels from WMS packing benches.
**Packing** turns picked stock into a ready-to-ship parcel. The packing workflow in WMS:
* Confirms the correct items are present (scan verification)
* Captures serial or batch information that must be verified at pack time
* Creates a shipment and prints a label via your Starshipit account
* Finalises stock movements and marks the order as shipped
Packing happens at a **Packing Bench** location - either after items have been picked and staged, or immediately after an expedited flow (Pack Now / Batch Pack Now).
Before using **Pack & Print Label**, confirm how the packing bench will handle labels. WMS can hand the label to the browser or Desktop App workflow available on that computer. If you use routed desktop printing, first [set up the Desktop App and its Print Client route](/articles/90200000000155-understand-how-starshipit-printing-works), then test the label type used by your courier at this bench.
## The packing dashboard
The **Packing dashboard** shows orders and pack jobs that are ready to be packed. You will typically see:
* Orders with completed pick jobs, with items staged at a packing bench
* Expedited orders sent directly to a bench via Pack Now or Batch Pack Now
From the packing dashboard, select an order or batch to open the **packing screen**.
Supervisors with permission to assign jobs can select Ready pack jobs, choose **Assign jobs**, and select one active WMS user. Only Ready pack jobs are selectable for this bulk assignment.
Use the **Packing Bench Report** when supervisors need to see what is waiting at each bench and where work is building up.
## Packing a single order
1. Select an order from the **Packing dashboard**.
2. Review the items and quantities that should be present.
3. Scan the **product barcode** for each item as you place it in the carton. On the desktop packing screen, you can also scan a label containing the item’s exact SKU:
* For **serial-tracked** items: scan or enter each serial number.
* For **batch-tracked** items: confirm the batch/lot and expiry date if required.
4. Repeat until all items are confirmed.
5. Select a packaging type (box, satchel, etc.) if required.
6. Complete the final item. By default, WMS creates the Starshipit shipment and prints the label automatically. If **Disable Auto Label Print** is enabled, select **Print Label** after packing is complete.
The packing job brings together product verification, carrier service, packaging, dimensions, weight and shipment cost before the label is created.
WMS validates that:
* The correct SKUs are packed (wrong items will be flagged).
* The correct quantities are packed.
* All required tracking (serial/batch) has been captured.
### If a discrepancy is found during packing
If an item is missing or wrong:
* Adjust the pick if it was a mis-pick.
* Update the order in Starshipit for substitutions or changes.
* Investigate stock levels via the inventory dashboard or movement logs.
## Partial packing
If you need to ship part of an order now and the rest later:
1. Pack and confirm the items you have.
2. Select **Partially Pack & Print Label**.
3. WMS prints a label for the packed quantity and keeps the remaining items open.
4. The order moves to **PARTIALLY_SHIPPED** status.
The remaining items can be packed and shipped once the stock is available.
If your account uses the dedicated ship workflow, packing and shipping are separate steps. Packers confirm the packed contents first, then shipping is completed from the shipping dashboard. Use this when your team separates pack verification from label generation or final carrier handoff.
## Pack screen customisation
The packing screen can be tailored to your workflow:
* **Column layout** - choose which columns appear in the items table, so packers see the fields most relevant to their process.
* **Bundle line visibility** - choose whether bundle parent lines are shown when packing orders that contain bundle products.
* **Delivery instructions** - open **Layout** and turn on delivery instructions when packers need the order's delivery notes above the shipping destination. This preference is stored in the current browser and is off by default.
* **Custom packaging** - create packaging records directly from the pack screen when standard templates are not suitable.
When selecting packaging, WMS uses package dimensions from Starshipit. If dimensions look wrong, check the package configuration in your Starshipit account.
## Duplicate a parcel
When an order needs another parcel with the same packaging details:
1. Expand **Packaging** on the desktop packing screen.
2. Select **Duplicate parcel** on the parcel you want to copy.
3. Review the added parcel's dimensions and weight, and adjust them if needed.
4. Select **Save to Starshipit** to sync the package changes.
Each duplicate adds one parcel, even if the original row has a quantity greater than one. You can edit the copy independently. When your package settings calculate weight from items, WMS redistributes the total item weight across the parcels; otherwise, it copies the original parcel's weight.
## Print and scan package barcodes
You need permission to manage fulfilment to print package barcodes. The package must already exist under **Setup > Packages**.
1. Open **Setup > Packages**.
2. Open the package's row actions and select **Print barcode**. To print several package labels together, select up to 100 packages and choose **Print barcodes** from the bulk actions.
3. Review the preview, choose a label layout, and select **Print**. WMS remembers the printed layout in this browser.
4. Scan the printed barcode on the desktop packing screen, then check **Packaging** to confirm the selected package.
The barcode selects the package by name and replaces the most recent parcel selection. If no parcel is selected, it adds one. It does not add another parcel on every scan. If the package name changes, print a replacement barcode.
## Packing summaries
A **packing summary** is a document listing items to be packed. You can generate:
* **Order-level summaries** - for a single order.
* **Batch-level summaries** - a consolidated list for multiple orders in a batch (commonly used with Batch Pack Now).
For Batch Pack Now workflows, WMS requires you to generate a packing summary before finalising. This acts as a consolidated pick/pack list - staff retrieve all items in one warehouse pass and sort them per order at the bench.
Batch order packing slips can download automatically, which is useful when packers need paperwork for every order in a batch before final label creation.
## How labels are generated
Once packing is complete, WMS creates a shipment via Starshipit:
1. WMS calls Starshipit's API using your existing carrier rules and services.
2. Starshipit generates the shipping label and tracking number.
3. WMS hands the label to the configured browser or Desktop App printing route for the packing bench.
4. Starshipit fires an **order_shipped** webhook back to WMS.
WMS then:
* Marks the order as **SHIPPED** (or **PARTIALLY_SHIPPED** for partial packs).
* Finalises pick and pack jobs.
* Writes **SHIPMENT** stock movements to reduce on-hand inventory.
If Starshipit rejects label creation because of a validation issue, such as a missing address or invalid service, WMS shows the error so you can correct the order before retrying. If a shipment and tracking number were created but nothing came out of the printer, reprint the existing label instead of creating another shipment. Check the receiving Desktop App machine, its local printer mapping, and the operating-system print queue.
If a shipment needs to be redone, WMS can hand off the redo flow while preserving the stock context needed to reopen the order at the correct location. Review the process log entry if a redo cannot be completed automatically.
Barcode alias matching is supported for shipper and product scans, helping packers scan expected barcode variants without manual lookup.
## Mobile packing
Mobile devices are automatically detected and redirected to a mobile-optimised packing experience. The mobile packing view supports:
* **At-bench mode** - load packing jobs assigned to a specific packing bench.
* **By order number** - look up and start a pack job by scanning or entering an order number.
* **Existing pack jobs** - open or claim a pack job that was created after picking.
In the standard workflow, completing a pick on mobile creates the pack job and returns the user to the jobs list. Packing then begins when the user opens or claims that pack job.
When packing on mobile, WMS prints the label automatically through Starshipit by default. If the account has **Disable Auto Label Print** enabled under **System > Settings > Packing**, the packer must select **Print Label** after completing the items.
## Best practices
* **Scan at packing to catch mis-picks.** Barcode verification at the pack step is your last chance to catch the wrong item before it ships to a customer.
* **Use partial packing rather than holding orders.** If one item is out of stock, ship what you have rather than blocking the whole order.
* **Use batch packing summaries for high-volume runs.** For Batch Pack Now or large batch picks, consolidated summaries reduce sorting errors at the bench.
* **Use the dedicated ship workflow when roles are split.** It keeps pack verification separate from final shipment handoff.
* **Keep packing benches tidy.** Staging clears the equipment location and moves stock to the bench - a tidy bench reduces mix-ups between orders.
## Related guides
* [Picking orders](/articles/14700000000011-picking-orders)
* [Expedited fulfilment (Pack Now & Batch Pack Now)](/articles/14700000000013-expedited-fulfilment-pack-now-batch-pack-now)
* [Orders and allocation](/articles/14700000000010-starshipit-wms-orders-and-allocation)
---
# Pick orders in WMS
URL: https://support.starshipit.com/articles/14700000000011-pick-orders-in-wms
Canonical: https://support.starshipit.com/articles/14700000000011-pick-orders-in-wms
Markdown: https://support.starshipit.com/articles/14700000000011-pick-orders-in-wms.md
Updated: 2026-08-31
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Work single-order, batch, and tote pick jobs from the Starshipit WMS desktop interface using barcode scanning or manual confirmation.
**Picking** is the process of collecting stock from warehouse locations for a released order. Before picking can begin, an order must be released and stock allocated — WMS then creates one or more pick jobs that tell your team exactly what to collect, from which location, and in what quantity.
This guide covers:
* How pick jobs are created and what they contain
* Working single-order pick jobs
* Batch pick jobs (multiple orders in one run)
* Tote-based picking
* Handling short picks and discrepancies
* Mobile picking
See [Orders and allocation](/articles/14700000000010-starshipit-wms-orders-and-allocation) for how to release orders and trigger pick job creation.
## The picking dashboard
The **Picking dashboard** lists all active pick jobs. For each job you can see:
* Job ID or Batch Pick ID
* Type (single order or batch)
* Status (Pending/Ready, In Progress, Completed)
* Number of orders and lines in the job
Pickers select a job, review what is required, and then walk the warehouse to collect items.
Supervisors with permission to assign jobs can select Ready pick jobs and choose the **Assign** bulk action to give them to one user. The picker must be an active WMS user who is available for assignment. Assigned or in-progress jobs can still be selected for packing summaries, but the bulk assignment action applies only to the selected Ready jobs.
## Shared picking interface
All pick types — single order, batch, tote, putaway, replenishment, and kitting — use the same picking interface:
* **Barcode scanning** to confirm picks
* **Serial and split-line support** for products that require unit-level tracking or split quantities
* **Unit of Measure support** — quantities respect any parent/child UoM configuration on the product
* **Scan history** — a log of all scans made during the session
* **+/− buttons** for manual quantity adjustment when scanning is not possible
* **Mark complete** to finish an individual pick line
This consistency means your team works the same way regardless of job type.
If your account requires source-location confirmation, pickers must scan the location before confirming each line. This is useful in warehouses where nearby bins hold similar products or where scan discipline is part of your accuracy process.
## Pick mode and equipment locking
When a picker starts a job, WMS locks that job to the selected pick mode and equipment context. For example, a tote pick must continue as a tote pick, and work assigned to a specific trolley, cart, or set of totes must continue with that same equipment.
A standard pick can use an available **Equipment** or **Tote** location as its equipment. WMS saves the choice before the first scan and restores it when the same job is resumed. Tote-pick mode keeps its separate one-tote-per-order assignment workflow.
This prevents stock from being picked into the wrong equipment or mixed with another job. If a picker opens the wrong mode or equipment by mistake, exit the job and restart from the correct option before recording picks.
## Single-order picking
One pick job corresponds to one order. WMS has already allocated specific stock in specific locations (and batch/serial where applicable).
### Working a single-order pick job
1. Select a job from the **Picking dashboard**.
2. Review the **picking list**:
* SKU and description
* Quantity to pick
* Source location
* Batch or serial information (if applicable)
3. Walk the warehouse and collect items from each location.
4. Scan or confirm each item as you pick it.
5. Place items into your equipment (trolley, tote) or directly into an order container.
6. Mark the job as **Completed** once all lines are done.
The web pick job keeps the equipment selection, source location, tracking details, quantity controls and overall progress visible while the picker works.
As items are picked:
* Allocations update from ALLOCATED to PICKED.
* Stock reduces at the source location.
* Stock moves into the picker's Equipment location (where configured).
If the allocated stock is not suitable but other stock is available, use reallocation to move the pick to a different valid allocation. Reallocation is also available in tote-pick workflows.
### When an item cannot be found
If stock is missing or less than expected:
1. Record the short pick (pick the quantity available).
2. WMS will flag the shortage.
3. You can then investigate via stocktake or adjustment, or partially ship the order and fulfil the rest when stock is available.
## Batch picking (multiple orders at once)
**Batch picking** combines items for multiple orders into a single pick job, reducing warehouse travel. The picker walks the warehouse once and collects combined quantities, then the items are sorted to individual orders at the packing bench.
### Working a batch pick job
1. Select the batch job from the **Picking dashboard**. The job shows a **Batch Pick ID**.
2. Use the picking list — which shows combined quantities per SKU and location across all orders — to collect all items in one pass.
3. Place items into totes or compartments labelled per order, or sort at the packing bench.
4. Mark the batch job as **Completed** once all items are picked.
Visual progress bars show completion at both the overall batch level and at the individual order level within the batch.
You can remove or skip individual orders from a batch if needed — for example, if one order is cancelled mid-process.
## Tote picking
Tote picking is a variant of batch picking where items are assigned to specific totes representing individual orders. This is especially useful for high-volume picking runs with many small orders.
1. Assign tote destinations at the start of the job.
2. Pick items and place each into the correct tote for that order.
3. Complete the tote pick transfer.
After completion, orders flow through the normal downstream packing workflow.
WMS tracks tote assignment state on job orders, so a tote remains linked to the right order as the job progresses. Ready-for-pack tote moves can be used when totes need to move cleanly from picking equipment to the packing bench before packing begins.
## Stage pick recovery
If a problem occurs during a staged pick (such as a network interruption), you can recover and resume from where you left off rather than starting the job over.
## Partial picking
If you cannot complete a pick job in one pass — for example, some stock is not available yet — you can use **Partially Pick** or **Partially Stage** to record progress and continue later:
1. Open the pick job.
2. Scan and confirm the quantities you have picked so far.
3. Select **Partially Pick** or **Partially Stage**.
These actions are only available after some progress has been recorded. If nothing has been picked yet, the standard full-action controls remain.
## Leaving or pausing a pick job
If you need to leave a pick job before it is finished, WMS prompts you to choose how to handle the job:
* **Leave the job open** — use this when you are stepping away briefly and the job can remain in progress.
* **Pause the job** — enter a reason so supervisors can see why the job is blocked, such as missing stock, equipment changeover, or waiting for manager review.
Use pausing when the issue needs follow-up from another team member. The pause reason helps managers prioritise work and understand why a job is not moving.
## Mobile picking
Pick execution is supported in the **Starshipit WMS mobile app**, including:
* Standard location-first picking with barcode scan and quantity confirmation
* Tote picking with tote destination assignment
* Serial-number scans and split-line handling where required by the product
* Staging picked items to the packing bench
Mobile picking is ideal for floor-based teams who need fast, hands-free execution.
:::important
Completing a pick does not open packing automatically. Once picks are staged, open or claim the separately created pack job in Starshipit WMS Mobile or continue from the WMS packing dashboard.
:::
## Next steps
* [Pick orders with Starshipit WMS Mobile](/articles/14700000000025-mobile-picking) — handheld picking for floor-based teams.
* [Packing and shipping orders](/articles/14700000000012-packing-and-shipping-orders) — how to verify, box and ship picked orders.
* [Expedited fulfilment](/articles/14700000000013-expedited-fulfilment-pack-now-batch-pack-now) — skip picking entirely for urgent orders with Pack Now.
---
# Use Pack Now and Batch Pack Now
URL: https://support.starshipit.com/articles/14700000000013-use-pack-now-and-batch-pack-now
Canonical: https://support.starshipit.com/articles/14700000000013-use-pack-now-and-batch-pack-now
Markdown: https://support.starshipit.com/articles/14700000000013-use-pack-now-and-batch-pack-now.md
Updated: 2026-07-22
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Skip the standard picking workflow and send orders straight to a packing bench using Pack Now or Batch Pack Now.
Pack Now and Batch Pack Now let you skip the standard picking workflow and send orders straight to a packing bench. Stock is still allocated and all inventory movements are recorded - the only thing that changes is your team doesn't scan each pick individually.
Use these flows when:
* An order is urgent and needs to ship immediately.
* Your picker and packer are the same person.
* You want to consolidate picking into one warehouse pass at the end of the day.
Use **Pack Now** when you want to move directly into packing. It is the expedited exception to the normal workflow - it is not the standard mobile pick completion path.
## Pack Now
Use **Pack Now** to fast-track a single order.
1. Open the order in WMS.
2. Click **Pack Now**.
3. Select the packing bench to send it to.
The order moves straight to the **Packing dashboard**, ready to pack. Your team retrieves the items from the shelf and brings them to the bench.
The **Pack Now** action is available from eligible order rows on the orders dashboard.
## Batch Pack Now
Use **Batch Pack Now** to fast-track multiple orders at once.
1. Select the orders you want to expedite.
2. Click **Batch Pack Now**, choose a packing bench, and confirm.
3. WMS generates a **Packing Summary** listing all SKUs and quantities across the batch.
Your team uses the summary to collect everything in one warehouse pass, then sorts items per order at the bench during packing.
## Kitting
**Kitting** is the process of assembling component products into a finished bundle or kit. If you use *require stock* bundles that need to be pre-built before shipping, you manage this from the **Kitting** section in WMS.
For urgent situations, use **Expedited Kitting** to create and execute a kitting job in a single step - select the bundle, set the quantity and destination, and submit.
## FAQ
Does skipping picking affect my inventory accuracy?
No. WMS still allocates stock and records all movements. The only difference is your team doesn't scan each item during picking - quantities are confirmed at the packing bench instead.
Can I choose which packing bench to use?
Yes. A selection dialog appears when you trigger Pack Now or Batch Pack Now.
Can I expedite orders with serial or batch tracking?
Yes. WMS allocates the correct serials and batches upfront; your team confirms them during packing.
---
# View inventory and stock levels
URL: https://support.starshipit.com/articles/14700000000014-view-inventory-and-stock-levels
Canonical: https://support.starshipit.com/articles/14700000000014-view-inventory-and-stock-levels
Markdown: https://support.starshipit.com/articles/14700000000014-view-inventory-and-stock-levels.md
Updated: 2026-08-31
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Monitor real-time stock levels by SKU and location, understand key inventory metrics, and use movement logs to trace every stock change.
The **Inventory dashboard** gives you a real-time view of your stock across the entire warehouse. It is your central reference for understanding what you have, what is committed to orders, what is available to sell, and what is on the way.
## Key inventory metrics
For every product (SKU), the inventory dashboard shows:
| Metric | What it means |
|---|---|
| **On hand** | Total physical quantity in the warehouse across all locations. |
| **Committed** | Quantity required to fulfil all open, unshipped orders. |
| **Available** | Stock that can still be allocated: *On hand − Committed*. A negative value means demand exceeds current stock. |
| **Incoming** | Quantity on open purchase orders that has not yet been received. |
| **Allocated** | Stock formally reserved in active pick jobs. An order can be committed but not yet allocated if it has not been released. |
Negative available quantities are highlighted so you can quickly spot where you are oversold or have a backorder situation.
> **Incoming is tracked at product level, not location level.** Since purchase orders represent stock that has not yet been placed into a specific bin, the Incoming figure is warehouse-wide rather than tied to a location.
## Filtering and searching
Use the dashboard filters to focus on what needs attention:
* Search by SKU or partial SKU code
* Filter to products with **negative availability** to find oversold items
* Filter to products with **incoming stock** to see what is due from open POs
* Use **allocatable-only** view to see orders that currently have enough stock to release
## The location-based view
In addition to product-level figures, WMS can show inventory by **location**. The location view lets you:
* Select a specific bin, shelf, or staging area
* See which products are stored there and in what quantities
* Drill into a product from the location's perspective
This is particularly useful for:
* Planning and running cycle counts
* Checking what is in a specific bin before a putaway decision
* Investigating discrepancies in a particular area of the warehouse
WMS maintains separate inventory records per product per location. The dashboard rolls these up to product-level totals; the location view exposes the breakdown.
If a location needs counting, open its row menu and select **Stocktake this location**. WMS opens the By Location stocktake with that location preselected, including eligible products already tied to it.
## Start a product stocktake from inventory
Use the product view when you want to turn an inventory search or filter into a count:
1. Apply the filters that define the products you want to count.
2. Select the relevant rows. To include matching products on other pages, select **Select all filtered products across all pages**.
3. Select **Start stocktake**.
4. Review the eligible products in the By Product stocktake before entering counts.
Select all supports up to 10,000 filtered products. Narrow the filters when the result is larger. If this device already has a By Product stocktake draft, WMS asks before replacing it. Bundle parents and other products that cannot be counted directly are excluded from the stocktake selection.
## Stock movement logs
Every inventory change in WMS is recorded as a **stock movement**. Movement logs give you a line-by-line history of what happened to each SKU.
Common movement reasons:
| Reason | Triggered by |
|---|---|
| **RECEIVE** | Stock received against a purchase order |
| **PUTAWAY** | Stock moved from staging to a storage location |
| **PICK** | Stock collected for an order |
| **TO_BENCH / PICK_STAGING** | Stock staged to a packing bench |
| **SHIPMENT** | Stock shipped on a completed order |
| **ADJUSTMENT** | Manual correction (damage, found, etc.) |
| **STOCKTAKE_VARIANCE** | Correction posted from a stocktake |
For batch- and serial-tracked products, movement logs show the specific batch or serial number involved. This supports traceability, recall investigations and compliance reporting.
Movement logs have a **Refresh** action to pull the latest data if you are reviewing recent changes and they are not yet visible.
## Reservations by order
From the inventory dashboard, you can see which specific orders are reserving stock for a product. This helps when investigating shortages: you can identify which orders are holding the committed quantity and decide whether to prioritise or defer any of them.
## Refreshing cached data
Some inventory views use cached data for performance. Use the **Refresh** action on the inventory dashboard if you expect recent changes (such as a receipt or adjustment) that are not yet visible.
## Looking up products by barcode
On both the Inventory and Products pages, you can scan or enter a barcode to find a specific product. This is useful on the warehouse floor when you have a product in hand and want to quickly check its stock level without knowing the SKU code.
## Exporting stock data
Use the **Export SOH Report** action on the inventory dashboard to download a CSV file of current stock-on-hand levels across all products and locations. This is useful for:
* Reconciliation with finance or accounting systems
* Sharing stock data with external partners
* Point-in-time inventory snapshots
## Related guides
* [Stocktakes and cycle counts](/articles/14700000000015-stocktakes-and-cycle-counts)
* [Replenishment](/articles/14700000000016-replenishment)
* [Restocking insights](/articles/14700000000017-restocking-insights)
---
# Replenish pick faces
URL: https://support.starshipit.com/articles/14700000000016-replenish-pick-faces
Canonical: https://support.starshipit.com/articles/14700000000016-replenish-pick-faces
Markdown: https://support.starshipit.com/articles/14700000000016-replenish-pick-faces.md
Updated: 2026-08-31
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Keep pick faces stocked using automated capacity-based replenishment and demand-driven job generation in Starshipit WMS.
**Replenishment** moves stock from bulk storage into pick faces so pickers always have accessible stock to fill orders. Without replenishment, pick faces run empty and picking stops — either because pickers can't find stock, or because allocation fails when no stock exists in pick-face locations.
Starshipit WMS supports four replenishment approaches:
* **Automated replenishment** — triggered by location capacity rules when a pick face drops to or below its minimum level.
* **Automatic demand replenishment** — creates work after pending-order demand is received.
* **Reviewed demand replenishment** — previews suggestions from pending orders before you create work.
* **Manual replenishment** — created ad hoc when you want to top up specific locations ahead of time.
## Setting up capacity rules
Capacity rules tell WMS when to automatically create a replenishment job for a pick face.
### Configuring min/max on a location
1. Open the location in the **Locations** section.
2. Set a **Minimum capacity** — the quantity at or below which a replenishment job should be triggered.
3. Optionally set a **Maximum capacity** — the target quantity to replenish up to. If not set, WMS uses the minimum as the target.
4. Save the location.
WMS only looks for replenishment stock in **bulk storage** locations. If no bulk stock exists for the product, no job is created.
### When replenishment is triggered automatically
Replenishment checks run as an event-driven process — not on a fixed schedule. Checks are triggered:
* After a stock movement that reduces pick-face quantity (such as a pick or stocktake adjustment)
* On some order-allocation failure paths where insufficient stock at pick faces is detected
* After a location is updated with changed capacity rules
When the check determines a pick face is at or below its minimum, WMS:
1. Looks for available stock of that product in bulk storage locations.
2. Creates a replenishment job targeting the minimum (or maximum, if set).
3. The job appears on the **Replenishment dashboard** for a picker to execute.
## Demand-driven replenishment
Demand-driven replenishment can run automatically after order imports or as a reviewed action from the Replenishment dashboard. Both modes aggregate pending-order demand, deduct pick-face stock and open replenishment work, and cap quantities by destination capacity and available bulk stock.
### Create work automatically from order demand
Use this mode when pick faces should be prepared as pending orders arrive instead of waiting for picking or an operator review.
1. Go to **System > Settings > Replenishment**.
2. Set **Create replenishment work** to **When order demand is received**.
3. Set **Replenish destination to** to **Configured minimum** or **Configured maximum**.
WMS immediately checks existing pending demand when you save the setting. It then checks aggregate pending demand after relevant order imports and creates replenishment work for positive shortfalls. The default remains **When picking requires stock**.
If a demand check fails, the imported order remains in WMS. Review the replenishment dashboard and process logs, then correct the stock, location or capacity issue. A later order update triggers another check.
### Review demand before creating work
Use **Generate from Demand** when a supervisor should review or adjust every suggested quantity before jobs are created.
1. Go to the **Replenishment dashboard** and select **Generate from Demand**.
2. Under **Target after demand**, choose **Location minimum** or **Location maximum**. If a location has no maximum, the maximum option uses its minimum.
3. Review the demand, current pick-face stock and open work, projected stock after demand, location capacity, and available bulk stock for each line.
4. Adjust **Reviewed qty** where needed. Enter `0` to leave a suggestion out of the jobs you create.
5. Select **Create reviewed replenishments**.
WMS can cap a suggestion when the pick face does not have enough capacity or there is not enough available bulk stock. It checks current stock, capacity, product compatibility, and source allocation again when you create the jobs, because warehouse activity may have changed since the preview loaded.
Running demand generation again does not duplicate or reprioritise open work that already covers the demand.
Use this before a high-volume picking run to ensure pick faces are stocked before pickers start. This is particularly useful for:
* End-of-day waves
* Flash sales or promotions
* Any time you have more demand than current pick-face stock can satisfy
## Working a replenishment job
Replenishment jobs are executed in two steps — pick from bulk, then place into the pick face:
**On desktop:**
1. Go to the **Replenishment dashboard** and select a pending job.
2. Review the product, source (bulk) location, destination (pick face), and quantity.
3. Confirm the movement.
**On mobile:**
1. Open the replenishment job in the WMS app.
2. **Phase 1 — Pick**: Navigate to the bulk storage location, confirm the product and quantity.
3. **Phase 2 — Move**: Confirm the destination pick face and submit the putaway.
Both phases are guided step-by-step with barcode scanning support.
The job detail keeps the source, destination, equipment, quantity and batch information visible while the replenishment is in progress.
## Manual replenishment planner
The **Manual Replenishment Planner** lets you create replenishment jobs on demand — useful for proactively topping up pick faces before a busy period without waiting for the automated trigger.
1. Open the replenishment or inventory view and select **Manual Replenishment Planner**.
2. Add one or more replenishment lines:
* Product (searchable dropdown)
* Destination location (pick faces only)
* Quantity to replenish
* Priority
3. Submit to create the jobs.
Rules that apply:
* SKU restrictions are enforced on destination locations — if a pick face is locked to specific SKUs, only those can be replenished to it.
* Quantities are validated and rounded to integers before submission.
## Assigning and prioritising replenishment jobs
You can assign replenishment jobs to specific team members and set their priority. Higher-priority jobs appear at the top of the queue on the Replenishment dashboard and in the mobile app.
Use the **Allocate Now** quick action on any Pending, Ready, or In Progress replenishment job from the dashboard row menu to trigger immediate assignment.
## Best practices
* **Set capacity rules on all active pick faces.** Even simple min levels (for example, 5 units) ensure you are notified before a face empties.
* **Use max capacity for high-velocity SKUs.** Without a max, replenishment consistently targets the minimum. For fast movers, a higher max reduces how often replenishment is triggered.
* **Use Generate from Demand before high-volume runs.** This catches shortfalls proactively, before pickers start walking and find empty picks.
* **Keep bulk stock topped up.** Replenishment can only create jobs when bulk stock exists. Monitor bulk locations for products with capacity rules to ensure there is always reserve stock available.
---
# Plan reorders with Restocking Insights
URL: https://support.starshipit.com/articles/14700000000017-plan-reorders-with-restocking-insights
Canonical: https://support.starshipit.com/articles/14700000000017-plan-reorders-with-restocking-insights
Markdown: https://support.starshipit.com/articles/14700000000017-plan-reorders-with-restocking-insights.md
Updated: 2026-09-04
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Plan reorders, create supplier-grouped draft purchase orders, and export stock forecasts from Restocking Insights.
Use **Restocking Insights** to identify products that need more stock, plan when to reorder them, and create draft purchase orders for review.
## Before you begin
To create draft purchase orders from the dashboard:
* You need permission to manage purchase orders.
* Create your supplier records, then assign a supplier to each product you want to reorder. See [Suppliers and purchase orders](/articles/14700000000007-suppliers-and-purchase-orders).
* Set each product's **Default unit cost**, **Warning stock level**, and **Ideal stock level**. Add a product-specific **Lead Time (days)** when it differs from the account default. Restocking Insights uses these values to calculate draft quantities, costs, and order dates.
Admins can configure the account-wide forecast under **System > Settings > Products > Restocking forecast**:
* **Restocking lead time** applies when a product has no lead-time override. The default is 5 days.
* **Minimum daily burn rate** hides products whose consumption falls below the configured floor.
* **Sales history (days)** controls the period used to calculate daily burn rate. The default is 30 days.
## Review your restocking forecast
Open [Restocking Insights](https://wms.starshipit.com/dashboard/restocking) to see the product-level forecast. The dashboard shows:
| Column | What it means |
|---|---|
| **Status** | The urgency of the forecast: Critical, Order Now, Attention, Healthy, or Unknown. |
| **Supplier** | The supplier assigned to the product. Products without one show **Missing supplier**. |
| **SOH** | The available quantity used by the forecast. It is warehouse stock minus reserved and committed quantities. |
| **Needed** | The quantity still required to reach the ideal stock level after subtracting outstanding confirmed and draft PO quantities. |
| **Plan Levels** | The product's warning and ideal stock levels. |
| **Burn Rate** | Average daily consumption over the configured sales-history window. |
| **Days Left** | Estimated days until the available quantity reaches zero at the current burn rate. |
| **Order By** | Recommended order date, calculated as the projected stockout date minus the product's lead time. |
| **Incoming** | Remaining quantity on Created or Partially Received POs. Draft PO quantities appear in parentheses. The next expected date appears when one is set. |
| **Stockout** | The date the available quantity is projected to reach zero. |
Expand a product row to review its stock history and forecast chart. A warning icon indicates that the forecast has limited sales history and may be less reliable.
## How Restocking Insights calculates demand
Restocking Insights uses outbound consumption movements from the configured sales-history window to calculate burn rate. It then combines that rate with available stock and the product's lead-time override, or the account-wide lead time, to project stockout and order dates. Products below the account's minimum daily burn rate are hidden from the forecast.
After meeting the minimum daily burn rate, products can appear when either of these conditions applies:
* They have a positive burn rate in the configured period.
* Their available stock is at or below the warning stock level and their ideal stock level is higher than the available quantity.
When the minimum daily burn rate is **0**, a product with no recent consumption can still appear when its warning and ideal stock levels show a restocking need. A higher minimum hides products below that floor, even when their stock levels show a restocking need. Products with neither recent consumption nor a configured threshold need are excluded.
The base restocking need is the ideal stock level minus the available quantity. WMS then subtracts the remaining quantities on confirmed and draft POs to calculate **Needed**. This prevents stock already on order from being included in another generated draft.
Use the **Missing Supplier** filter to find products that cannot be added to supplier-grouped draft POs. If you can manage account-level products, you can assign a supplier directly from the **Supplier** column while this filter is active.
## Create draft purchase orders
The **Create Draft POs** action uses all qualifying products on the dashboard, even when you have applied a search or status filter.
1. Review **Needed**, **Incoming**, and the assigned supplier.
2. Confirm that each product you want to include has the correct supplier and default unit cost.
3. Select **Create Draft POs**.
4. Check the confirmation message for the number of POs and line items created.
WMS creates one **DRAFT** purchase order per supplier. Each draft contains the supplier's qualifying products, the net **Needed** quantity, and the product's default unit cost.
Products that need stock but do not have a supplier are skipped. Assign a supplier to the product, then run the action again if you still need a draft for it.
## Review and issue the drafts
Drafts are not ready for receiving until you review and create them.
1. Select **Review Draft POs** to open the purchase-order list filtered to **DRAFT**.
2. Open each new PO.
3. Check the supplier, line items, quantities, unit costs, and total.
4. Add an **Expected Arrival Date** if you want Restocking Insights to show when the confirmed stock is due.
5. Add, remove, or update line items as needed.
6. Select **Save as Draft** to keep editing later, or **Create PO** to change its status to **CREATED**.
## Export restocking data
Select **Export CSV** to download all rows that match the current search and status filter, in the current sort order. The export is not limited to the page you are viewing.
The CSV includes:
* SKU, product name, supplier, and status
* SOH, warning stock level, ideal stock level, and net quantity to order
* Burn rate, days left, order-by date, stockout date, and projection reliability
* Confirmed incoming quantity, draft incoming quantity, next incoming stock date, and order-overdue details
Use the export to review reorders outside WMS or share the forecast with your procurement team or suppliers.
## Check the Operations dashboard summary
The [Operations dashboard](https://wms.starshipit.com/dashboard/operations) includes a restocking summary card with the number of products that need attention. Select the card to open the full product-level forecast.
## FAQ
Why are some products not appearing on the Restocking Insights dashboard?
To appear, a product's burn rate must meet the account-wide minimum. It must also have either a positive burn rate or warning and ideal stock levels that show a restocking need. Check the product's visibility, sales history, **Warning stock level**, **Ideal stock level**, and the account's **Minimum daily burn rate**.
What does SOH mean on this dashboard?
The Restocking Insights **SOH** value is the available quantity used for forecasting. It starts with physical warehouse stock and subtracts reserved stock and quantities committed to open orders.
Why was a product skipped when I created draft POs?
WMS skips a product that has a positive **Needed** quantity but no assigned supplier. Use the **Missing Supplier** filter and assign the correct supplier, then create another batch if the product still needs stock.
Does Restocking Insights create purchase orders automatically?
No. WMS does not create POs in the background. When you select **Create Draft POs**, WMS creates supplier-grouped drafts for you to review, edit, and change to **CREATED** when ready.
## Related articles
* [Suppliers and purchase orders](/articles/14700000000007-suppliers-and-purchase-orders)
* [Inventory dashboard and stock visibility](/articles/14700000000014-inventory-dashboard-and-stock-visibility)
---
# Adjust stock and investigate stock movements
URL: https://support.starshipit.com/articles/14700000000020-adjust-stock-and-investigate-stock-movements
Canonical: https://support.starshipit.com/articles/14700000000020-adjust-stock-and-investigate-stock-movements
Markdown: https://support.starshipit.com/articles/14700000000020-adjust-stock-and-investigate-stock-movements.md
Updated: 2026-09-15
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Use stock adjustments, movement logs, and process logs to keep inventory accurate and maintain a reliable audit trail over time.
Even with well-run processes, inventory drifts over time. Damage, mis-picks, supplier short-ships, and process gaps all create small variances that compound. The tools in this guide help you correct those variances and understand why they happened.
**Stock integrity** tools in WMS include:
* **Manual stock adjustments** — immediate corrections to on-hand quantities
* **CSV adjustment batches** — import or export manual adjustment batches when many rows need correction
* **Location-wide adjustments** — adjust all inventory in a location when a whole area needs correction
* **Packaging inventory** — tracking consumable packaging items
* **Stock movement logs** — a line-by-line history of every inventory change
* **Process logs** — a timeline of system events (orders, jobs, syncs)
* **Process log warnings** — actionable alerts for issues that need attention
## Manual stock adjustments
Use **stock adjustments** to correct inventory outside of a stocktake. Common uses:
* Recording damaged or lost stock
* Accounting for shrinkage or theft
* Adding found stock to the system
* Correcting a known data entry error quickly
### Creating an adjustment
You need `inventory.adjust` and existing products and locations to create adjustments.
1. Go to **Inventory > Stock Adjustments > Adjustments**.
2. Select the **product (SKU)**.
3. Choose the **location** — the form shows current quantities at each location so you can make an informed choice.
4. Enter the **quantity** (positive to add stock, negative to remove it).
5. Select a **reason code** (Damage, Found, Administrative correction, etc.).
6. Select **Add adjustment to batch**.
7. Review the queued rows, then select **Submit adjustments**.
For batch- or serial-tracked products, WMS will prompt you to select or enter the specific batch or serial number being adjusted. This keeps traceability intact.
The adjustment builder shows the product, location, current stock, quantity change and reason before you add the line to a batch.
Each successful submitted adjustment updates on-hand inventory and creates a stock movement record. Adding or importing a queued row does not change inventory.
:::note
Use adjustments sparingly. Frequent adjustments usually indicate a process issue rather than a one-off event. Review patterns in movement logs to identify root causes.
:::
### Adjustment batches and location corrections
For larger corrections, use CSV import and export on **Inventory > Stock Adjustments > Adjustments**. Each batch supports up to 200 rows, and import files must be 5 MB or smaller. There is no standalone blank adjustment template.
1. Add a representative adjustment to the batch.
2. Select **Export batch (count) (CSV)** to download the queued batch. The count shows the number of queued rows.
3. Edit that file with the required corrections, keeping the headers and required tracking details.
4. Remove any queued rows duplicated in the file, then select **Import CSV**. Imported rows are added to the existing batch.
5. Review the queued rows and validation errors, then select **Submit adjustments**.
6. Verify the resulting balances and stock movements. Successful rows leave the queue; correct and retry only the failed rows.
Split larger corrections into batches of up to 200 rows. See [Import and export WMS data by CSV](/articles/14700000000041-import-and-export-wms-data-by-csv) for the adjustment columns.
For physical reconciliation, use **Inventory > Stocktakes** to export a stocktake CSV, enter counted quantities, and import the file to submit the counts. See [Run stocktakes and cycle counts](/articles/14700000000015-run-stocktakes-and-cycle-counts) for approval and processing. Use location-wide adjustment only when the entire location has been counted or cleared and you are confident every line should change.
## Packaging inventory
Packaging materials (boxes, satchels, void fill, inserts) can be tracked as inventory in WMS:
* Adjust packaging stock the same way as product stock
* Movement logs provide a full audit trail for packaging consumption
* When an order ships, packaging is automatically decremented if packaging items are configured on shipments
## Stock movement logs
Every inventory change — regardless of how it happened — is recorded as a **stock movement**. These logs are your primary audit tool.
Common movement reasons you will see:
| Reason | What triggered it |
|---|---|
| RECEIVE | Stock received against a purchase order |
| PUTAWAY | Moved from staging to a storage location |
| PICK | Collected for an order |
| TO_BENCH | Staged to a packing bench |
| SHIPMENT | Shipped on a completed order |
| ADJUSTMENT | Manual stock correction |
| STOCKTAKE_VARIANCE | Change posted from a stocktake or cycle count |
| REPLENISHMENT | Moved from bulk to a pick face |
| KITTING | Stock consumed or created by a kitting job |
For batch- and serial-tracked products, logs are linked to specific batch or serial numbers — supporting recall, compliance and supplier dispute scenarios.
The **Actor** column and expanded movement details show who performed each new movement. User actions show the recorded user, automated movements show **System**, and older movements created before actor tracking show **Unknown**. The Actor value is also included when you export filtered movement history to CSV.
Use the **Refresh** action on the movement log view to pull the latest data if recent changes are not yet visible.
Filtered stock movement views can be exported. Use this when investigating a supplier issue, customer claim, stocktake variance, or finance reconciliation.
## Process logs
**Process logs** record higher-level system events:
* Order imported into WMS, and status changes (PENDING → RELEASED → SHIPPED)
* Pick and pack job creation and completion
* Expedited flows (Pack Now, Batch Pack Now)
* Product syncs from Starshipit or connected commerce platforms
* Background operations and scheduled tasks
Process logs also capture commerce inventory sync results — useful when investigating whether a failed sync caused a discrepancy between WMS and a connected storefront or inventory platform.
Process log rows can be actioned in bulk where supported, such as resolving reviewed entries or retrying eligible failed processes. Older process logs may move into archive storage, so use filters and date ranges when investigating historical issues.
### Actionable warnings in process logs
The Dashboard surfaces **actionable warnings** for issues that need your attention, such as:
* Missing SKUs during order import (an order arrived but WMS did not recognise a product SKU)
* Integration errors during inbound or outbound flows
Each warning includes context about what went wrong and options to:
* **Retry the import** — re-attempt the operation using the stored event
* **Create missing SKUs** — navigate to product creation pre-filled with the missing details
* **Dismiss** — mark as resolved if the issue is no longer relevant
Warnings automatically resolve when the underlying issue is fixed.
## Investigating a discrepancy
When you find unexpected variances during a stocktake, cycle count or order shortfall, use this approach:
1. **Identify the scope** — which SKU? which location? is it a one-off or recurring?
2. **Check movement logs** for:
* Recent adjustments you were not aware of
* Unusually large or small receipt quantities
* High-volume picks or expedited flows that may have bypassed normal scanning
* Returns or write-off adjustments
3. **Check process logs** for:
* Orders that changed, were cancelled, or were re-allocated close to the time of the variance
* Expedited flows (Pack Now, Batch Pack Now) that completed picks without scanning
4. **Run a cycle count** for each affected product and location to confirm the physical quantity.
5. **Post a correction** via cycle count or manual adjustment with an appropriate reason code.
6. **Address the root cause** — update processes, add training, or adjust location setup to prevent recurrence.
## Practices for long-term stock integrity
* **Use consistent reason codes.** Standard codes (Damage, Lost, Found, Stocktake variance, Supplier error) make it possible to report on patterns.
* **Schedule cycle counts.** Count fast-moving, high-value or problem-prone SKUs regularly — weekly or fortnightly for the highest-risk items.
* **Restrict who can create manual adjustments.** Limit this permission to specific roles to reduce untracked or accidental changes.
* **Align with finance.** Write-offs and scrap recorded in WMS should be reflected in your financial systems where applicable.
* **Review movement logs regularly with your team.** When issues arise, walk through the log together to identify what happened and build better habits.
---
# Track stock in containers
URL: https://support.starshipit.com/articles/14700000000034-track-stock-in-containers
Canonical: https://support.starshipit.com/articles/14700000000034-track-stock-in-containers
Markdown: https://support.starshipit.com/articles/14700000000034-track-stock-in-containers.md
Updated: 2026-08-17
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Track stock in physical containers, scan container barcodes, and move containers through receiving, storage, picking and replenishment.
Container tracking lets you record stock in a physical container and follow that container as it moves through your warehouse. Use it when stock is handled in cartons, pallets, cages, bins or another identifiable unit.
## How containers work
A container has its own reference, barcode, current location and contents. The contents are the inventory records associated with that container.
Containers can be used while receiving stock, moving stock between locations, picking and replenishing. WMS keeps the container reference with the related stock movements so you can see how the stock travelled through the warehouse.
## Create and identify a container
1. Go to **Containers** from the WMS navigation.
2. Select **Create container**.
3. Enter a unique reference and, if required, a barcode.
4. Select the current warehouse location.
5. Save the container.
Use a reference that matches the identifier printed or attached to the physical container. This makes it easier for warehouse staff to confirm they are working with the right unit.
### Create containers in bulk
Use bulk creation when you need a numbered run of containers at the same location.
1. Go to **Containers**.
2. Select **Create in bulk**.
3. Enter a quantity from 1 to 10,000.
4. Select the current location.
5. Select **Create containers**.
WMS assigns sequential `CON-` barcodes. To change the first number in the next run, go to **System > Settings > Receiving > Container Numbering** before creating the containers.
### Print container barcode labels
Open a container's actions to print one barcode, or select up to 100 containers and choose **Print _n_ barcodes**. Review the barcode preview, choose the label size, then select **Print**.
## Add stock and move a container
During receiving, WMS can associate received stock with a container. The stock remains visible by product and location, while the container view shows the same stock grouped by its physical unit.
To move a container, open it from the **Containers** dashboard, choose **Move**, then select the destination location. WMS records the movement against the inventory in the container and updates its current location.
Do not use a container move when only part of the container contents are moving. Move the relevant stock through the normal stock movement workflow instead, so the container contents remain accurate.
For a partial move, go to **Stock Adjustments** and select the product, source and destination locations. Use **Source Container** and **Destination Container** to identify the physical containers on each side of the movement. Select **Loose stock (no container)** when stock is entering or leaving a container without another container on that side. WMS only offers containers at the matching source or destination location.
## Find a container on the warehouse floor
You can find a container in three ways:
* Scan its barcode.
* Search its reference in **Unified search**.
* Open the **Containers** dashboard and filter by reference or location.
The container detail view shows the current location and inventory associated with the container. Use stock movement history when you need to investigate where it has been or why its contents changed.
## Archive a container
Archive a container when it is no longer used. Before archiving, make sure it does not contain stock that still needs to be tracked in that physical unit.
Archiving removes the container from normal active use without removing its history from stock movement records.
## Related guides
* [Unified search](/articles/14700000000022-unified-search)
* [Receiving stock](/articles/14700000000008-receiving-stock)
* [Replenishment](/articles/14700000000016-replenishment)
---
# Run stocktakes and cycle counts
URL: https://support.starshipit.com/articles/14700000000015-run-stocktakes-and-cycle-counts
Canonical: https://support.starshipit.com/articles/14700000000015-run-stocktakes-and-cycle-counts
Markdown: https://support.starshipit.com/articles/14700000000015-run-stocktakes-and-cycle-counts.md
Updated: 2026-09-15
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Run stocktakes from Inventory > Stocktakes in WMS web, count a location in WMS Mobile, and create, complete, or approve targeted inventory counts.
Inventory counts keep WMS accurate over time. No matter how tightly you control processes, small variances accumulate — mis-picks, damage, supplier short-ships, and process gaps all affect stock levels. Regular counting catches and corrects these variances before they cause fulfilment problems.
WMS supports these counting workflows:
* **Stocktakes** — count a defined set of SKUs or locations, then post corrections.
* **Stocktake by Location in WMS Mobile** — scan or select one location, count every eligible product there, then submit the variances.
* **Cycle counts** — ongoing counts for one product at one location, managed as individual jobs.
* **Count as you go** — count products as part of normal warehouse work when you need quick confirmation without starting a full stocktake.
Manual cycle count creation is available from the WMS web dashboard. Workers can open and complete an existing cycle count job in WMS Mobile, but cannot manually create one there.
If you need to prevent allocation while counts are being investigated, use inventory freeze controls for the affected products or locations. Frozen inventory cannot be allocated until the freeze is cleared.
## Stocktakes
### Counting modes
Stocktakes support two modes, available as separate tabs:
| Mode | When to use |
|---|---|
| **By Product** | Select one or more SKUs to count across all their locations. Useful for investigating a specific product that is frequently short. |
| **By Location** | Select a warehouse location and count every product stored there. Best for zone-based or location sweep counts. |
When **By Location** mode is selected, the By Product tab is hidden to keep things unambiguous.
### Starting a stocktake
You need `stocktake.count` to create and submit a stocktake. The separate `stocktake.approve` permission controls whether your submission can be applied immediately or needs another authorised user to approve it.
1. Go to **Inventory > Stocktakes** in WMS.
2. Select the counting mode (**By Product** or **By Location**).
3. Define the scope:
* For **By Product**: choose the SKUs to count.
* For **By Location**: select the location. The dropdown defaults to your configured default stocktake location.
4. WMS generates the stocktake list with expected quantities.
Drafts are preserved per location — if you switch between locations, your unsaved counts are not lost.
### Start a stocktake from Inventory
Use the Inventory page when you already know which products you want to count:
1. Go to **Inventory** in WMS web.
2. Select one or more products using the row checkboxes.
3. Select **Start stocktake** from the bulk action bar.
4. WMS opens a **By Product** stocktake with the eligible selected products ready to count.
The action shows how many selected products are eligible for a stocktake. If some selected products are not eligible, WMS excludes them from the count.
### Counting inventory
For each item in the stocktake list:
* **Standard products**: enter the counted quantity.
* **Batch-tracked products**: verify each batch, enter the counted quantity per batch, and optionally confirm expiry dates.
* **Serial-tracked products**: confirm individual serial numbers (or import them via file where supported).
You can scan product barcodes to increment counts instead of typing quantities manually. If you find products at a location that were not previously recorded there, you can add lines to the count.
You can also change a product to a different location during a stocktake — WMS records a stock movement to transfer inventory to the new location for an accurate audit trail.
Large location counts are paginated, and empty or zero-result locations load quickly. This keeps location-based stocktakes usable in larger warehouses.
### Count using a CSV file
1. Go to **Inventory > Stocktakes** and select the products for a **By Product** stocktake.
2. Select **Export stocktake (CSV)**.
3. Enter the physical counts in `countedQuantity`, keeping the identifying columns, locations, and required batch or serial details.
4. Review the file, then select **Import CSV** to submit its valid counts. Importing submits directly; it does not create an editable draft or require a separate **Save stocktake** action.
5. Check the submission result and any skipped-row warnings. With `stocktake.approve`, processing is queued immediately. Otherwise, the submission is **Awaiting approval**.
Unknown location names block the import. Correct them before retrying. After approval and processing, verify the inventory balances and stock movements. See [Import and export WMS data by CSV](/articles/14700000000041-import-and-export-wms-data-by-csv) for column rules and recovery steps.
### Reviewing variances and posting
Once counting is complete:
1. WMS calculates variances by comparing expected to counted quantities.
2. Review the differences — investigate any large or unexpected variances before posting.
3. When satisfied, submit the stocktake.
If you have both `stocktake.count` and `stocktake.approve`, WMS queues the stocktake for background processing immediately. If you can count but cannot approve, WMS saves the submission as **Awaiting approval** and does not change inventory yet.
### Approve or decline a stocktake
Users with `stocktake.approve` can review submitted stocktakes from the **Stocktakes** dashboard. Each submission shows who submitted it, its status, and each product's current quantity, counted quantity, and variance.
1. Go to **Inventory > Stocktakes**.
2. Select **Review** beside an **Awaiting approval** submission.
3. Compare the current quantity, counted quantity, and variance for every product.
4. Select **Approve and apply** to queue the changes, or **Decline** to close the submission without changing inventory.
Approval uses the current inventory quantity shown at review time. If warehouse activity continued after the count was submitted, investigate unexpected differences before approving.
After approval, select **View background work** from the confirmation or go to **Operations > Background Work** to check processing status.
When processing completes, WMS generates **inventory adjustments** with reason "Stocktake variance" for every discrepancy. These update on-hand quantities and are logged in stock movements.
Stocktakes do not change inventory while you are counting or while a submission is awaiting approval. Submitting clears the local draft. Approving queues the corrections, so confirm the variances first. Only one approved stocktake can process for an account at a time.
### Run Stocktake by Location in WMS Mobile
Use **Stocktake by Location** for a standalone location count in WMS Mobile. This is a stocktake, not a cycle count job, and requires the `stocktake.count` permission.
1. Open **More > Stocktake by Location** in WMS Mobile.
2. Scan the location barcode, or search for and select a location when manual selection is available.
3. Enter the physical count for each product. You can scan products as you count and add an eligible unexpected product that you find at the location.
4. Review the changed products, expected quantities, counted quantities, and variances.
5. Submit the stocktake.
WMS queues the stocktake immediately if you also have `stocktake.approve`. Otherwise, it saves the submission as **Awaiting approval** for an authorised user to review in WMS web.
:::important
Finish and submit the location count before leaving this mobile workflow. WMS Mobile does not save an unfinished stocktake draft after you leave.
:::
## Cycle counts
**Cycle counts** are smaller, more frequent jobs that verify a product's physical quantity at a specific location. Rather than counting your entire warehouse periodically, cycle counts let you continuously check high-risk or high-value inventory records.
### Cycle count dashboard
The **Cycle Count** section in WMS has its own dashboard showing all cycle count jobs with their status, assigned user, location, product, and priority.
From the dashboard you can:
* Create one cycle count job for one product at one eligible location
* Assign jobs to specific team members
* Adjust job priority to surface urgent counts first
WMS can also create a cycle count job when a worker reports a discrepancy during warehouse work. This existing discrepancy-driven workflow remains available.
### Before you create a cycle count
You need the WMS cycle-count workflow permission (`cycle-count.*`) to see and use **Create Cycle Count**. A generic job create or manage permission does not reveal this control.
Manual creation supports one product at one location only. The location must already have an inventory record for the selected product. Tote and equipment locations are not eligible.
### Create a cycle count from the dashboard
1. Go to the **Cycle Count** dashboard in WMS web.
2. Select **Create Cycle Count**.
3. Select exactly one product.
4. Select exactly one eligible location from the locations where that product has an inventory record.
5. Confirm the job.
WMS saves the system quantity at creation as the expected baseline. The physical or reported count stays blank until a worker performs the count. Creating the job does not confirm or pre-fill the system quantity as the physical count.
Only one active cycle count can exist for a location. If an active job already uses the selected location, WMS tells you that a job already exists for that location.
To resolve the conflict:
1. Return to the **Cycle Count** dashboard.
2. Find the active job for the location in the **Location** column.
3. Open and complete the existing job, or assign it to a worker who can perform the count.
4. After that job is complete, create another only if the location still needs a new count.
After creation, use the existing supported surfaces and permissions to assign, prioritise, run, and complete the job.
When you open a cycle count, the job shows the expected quantity, reported quantity, variance, location confirmation, and tracking details before the count is posted.
### Running a cycle count on mobile
WMS Mobile can work an existing cycle count job. It does not include the manual **Create Cycle Count** action.
1. Open the cycle count job on the WMS mobile app.
2. Scan the location barcode to confirm you are in the right place.
3. Scan products and enter counted quantities.
4. Submit the count — WMS calculates variance and creates adjustment movements if needed.
You can also submit quick adjustments directly from mobile without a formal cycle count job — useful for immediate corrections spotted during other tasks.
### When cycle counts post
When a cycle count is posted, WMS creates stock movement adjustments (positive or negative) that can be reviewed in movement logs. These are identical in effect to stocktake variances and contribute to your audit trail.
## Best practices
* **Run full stocktakes periodically.** Quarterly or annual full counts keep your overall inventory accuracy benchmark fresh.
* **Use cycle counts frequently for high-risk areas.** Count fast-moving, high-value, or frequently mis-picked SKUs more often — weekly or fortnightly for problem-prone products.
* **Pause movements during counts where possible.** If orders continue to move through the counted area while counting is in progress, your counts may not match reality. Count areas during low-activity windows where practical.
* **Investigate large variances before posting.** A large unexpected variance may indicate a process error, data entry mistake, or theft. Investigate before committing.
* **Use reason codes on adjustments.** When corrections are applied, use consistent reason codes (Damage, Found, Lost, Stocktake variance) so you can report on patterns over time.
## FAQ
Do I need to stop operations during a stocktake?
For the most accurate results, it is best to pause movements for the items or locations being counted. If operations continue, stock movements happening in real time may cause discrepancies between your count and the system's expected figure.
Can I undo a posted stocktake?
You cannot reverse a stocktake directly. However, you can create a manual adjustment with the opposite quantity to correct any posted values. Both entries will appear in movement logs for traceability.
What is the difference between a stocktake and a cycle count?
Both correct inventory through counting. A stocktake is a broader one-off count across a defined scope, such as multiple SKUs or every product at a location. A cycle count is a job-based approach for counting one product at one location. In practice, the outcome is the same — variance adjustments are posted and movement logs updated.
Can I create a cycle count for a whole location or multiple products?
No. Manual cycle count creation supports one product at one eligible location per job. It does not support a location-only count, one product across all locations, an arbitrary set, or bulk creation. Use a **By Product** or **By Location** stocktake when you need a broader counting scope.
Can I create a cycle count in WMS Mobile?
No. Create a manual cycle count from the **Cycle Count** dashboard in WMS web. WMS Mobile can open and complete an existing cycle count job, and reporting a discrepancy during warehouse work can still create a follow-up job automatically.
Can I run a stocktake in WMS Mobile?
Yes. Open **More > Stocktake by Location** to count and submit all eligible products at one location. This is separate from cycle count jobs. WMS Mobile does not currently support a **By Product** stocktake or save an unfinished location stocktake after you leave the workflow.
---
# Transfer stock between warehouses
URL: https://support.starshipit.com/articles/14700000000040-transfer-stock-between-warehouses
Canonical: https://support.starshipit.com/articles/14700000000040-transfer-stock-between-warehouses
Markdown: https://support.starshipit.com/articles/14700000000040-transfer-stock-between-warehouses.md
Updated: 2026-07-20
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Transfer stock between eligible Starshipit WMS accounts and track the source order, destination purchase order, shipment, and receipt.
Use an inter-warehouse transfer to send stock from one Starshipit WMS account to another eligible WMS account in the same Starshipit account family. This guide explains how to create, fulfil, receive, and reconcile the transfer.
:::important
An inter-warehouse transfer moves stock between separate WMS accounts. It creates a real Starshipit order for the source warehouse and a purchase order for the destination warehouse. To move stock between locations in one WMS account, use the normal stock movement workflow instead.
:::
## Before you begin
Confirm the following before you create a transfer:
* The source and destination are different Starshipit accounts in the same parent and child account family. This is typically two sibling warehouse accounts.
* Starshipit WMS is enabled for both accounts. Only eligible family accounts with a WMS instance appear as destinations.
* The destination account has a complete sender address in Starshipit. WMS uses this as the delivery address on the source order.
* Each selected source product has a SKU of 50 characters or fewer, and each transfer quantity is a positive whole number.
* Each product also exists in the destination WMS account with the same SKU. WMS matches products by SKU rather than product name. Matching ignores upper- and lower-case differences, but using identical SKU formatting avoids confusion.
* The source warehouse has enough available stock to release the order. Creating the transfer does not reserve or check source inventory.
The workflow uses these permissions:
| Task | Required permission |
| --- | --- |
| Open, view, or create transfers | Manage purchase orders (`purchase-orders.manage`) |
| Open the linked source order | View fulfilment (`fulfillment.view`) |
| Release the source order | Manage fulfilment (`fulfillment.manage`) |
| Open the linked destination purchase order | View purchase orders (`purchase-orders.view`) |
| Receive the destination purchase order | Complete receiving tasks (`receiving.*`) |
| Investigate order import events | View process logs (`process-logs.view`) |
Your team can split these tasks between authorised users in each warehouse.
## Create the transfer
Create the transfer while signed in to the WMS account that will send the stock.
1. Go to **Purchase Orders > Transfers**.
2. Select the **Destination warehouse** under **Create Transfer**.
3. Click **Add product** and select a product from the source warehouse.
4. Enter the quantity to transfer.
5. Add any other products required.
6. Review the SKUs and quantities, then click **Create transfer**.
WMS creates three linked records:
* A real Starshipit order in the source account, addressed to the destination warehouse.
* A purchase order with status **CREATED** in the destination WMS account. WMS creates or reuses a supplier named **Internal Transfer - _source warehouse name_**.
* An inter-warehouse transfer record visible to both WMS accounts.
The source order, destination purchase order, and transfer share an `XFER-...` reference. Use this reference to match the records throughout the workflow.
The transfer initially shows **Waiting on webhook** while the new Starshipit order imports into the source WMS account. Click **Refresh** under **Recent Transfers** to load the latest status.
## Release and ship from the source warehouse
After the source order has imported, it behaves like another outbound Starshipit order.
1. Open the source WMS account.
2. Go to **Purchase Orders > Transfers** and find the `XFER-...` reference.
3. Open the linked source order.
4. Review its products, quantities, destination address, and available inventory.
5. Release the order to allocate stock and create the required pick work.
6. Pick, pack, and ship the order using your normal outbound workflow.
The transfer changes to **Released**, **Partially shipped**, or **Shipped** as the source order progresses.
## Receive at the destination warehouse
Receive only the stock that physically arrives at the destination.
1. Switch to the destination WMS account.
2. Go to **Purchase Orders > Transfers** and find the same `XFER-...` reference.
3. Open the linked destination purchase order.
4. Compare the delivered SKUs and quantities with the purchase order.
5. Receive the quantities that arrived, including any required batch, serial, or expiry details.
6. Complete putaway using your normal receiving workflow.
The transfer becomes **Partially received** while quantities remain outstanding. It becomes **Completed** when the destination purchase order is marked **RECEIVED**.
:::caution
Do not mark the destination purchase order as fully received until you have reconciled the physical delivery. A **Completed** transfer means the purchase order is **RECEIVED**; it does not independently prove that the source shipment and received quantities match.
:::
## Understand transfer statuses
| Status | What it means | What to do next |
| --- | --- | --- |
| **Waiting on webhook** | Starshipit created the source order, but the source WMS account has not imported and linked it yet. | Wait briefly, then click **Refresh**. |
| **Created** | The source order is in WMS and is waiting to be released. The destination purchase order already exists. | Review and release the source order. |
| **Released** | Source stock is allocated and outbound work has started. | Pick, pack, and ship the source order. |
| **Partially shipped** | Some source quantities shipped, but others remain outstanding. | Continue the remaining source fulfilment or reconcile the short shipment. |
| **Shipped** | The source order is fully shipped. | Receive the delivery at the destination. |
| **Partially received** | The destination recorded some, but not all, expected stock. | Leave the purchase order open and receive the remainder when it arrives. |
| **Completed** | The destination purchase order is **RECEIVED**. | Confirm quantities match and finish putaway. |
| **Cancelled** | The linked source WMS order has status **CANCELLED**, and the destination purchase order has no receipt. | Stop any remaining work and reconcile the destination purchase order separately. |
Receiving takes precedence in the transfer summary. If the destination has already received stock, the transfer continues to show **Partially received** or **Completed** even if the source order is later cancelled.
## Handle partial transfers
If the source workflow results in a partial shipment, you do not need to create a new transfer for the remaining quantity.
1. Confirm the quantity that shipped from the source. The transfer shows **Partially shipped** while units remain outstanding.
2. Receive only the quantity that physically arrives. The destination purchase order and transfer show **Partially received**.
3. Keep the destination purchase order open.
4. Continue the normal source fulfilment workflow for the outstanding units when they become available.
5. Receive the remaining quantity when it arrives.
6. Mark the destination purchase order as fully received only after all expected stock is accounted for.
If the remaining stock will not be sent, reconcile the source order and destination purchase order before closing either record. Record the actual quantities rather than using a manual stock movement to make the transfer appear complete.
## Cancel a transfer
There is no separate **Cancel transfer** action. **Cancelled** is a summary status that can appear when the linked source WMS order is already **CANCELLED** and the destination has not recorded a receipt. The destination purchase order remains a separate record.
If a transfer must stop before anything has shipped or been received:
1. Stop further outbound work on the source order using the appropriate hold or undo release action.
2. Follow your organisation's normal Starshipit order-cancellation process. Contact Starshipit support before deleting or archiving the source order if you are unsure how its linked records will be affected.
3. Confirm the source warehouse has no active pick or pack work for the order.
4. Switch to the destination account and confirm that no quantities were received against the purchase order.
5. Keep the `XFER-...` reference with any operational notes so both warehouses have the same record of the cancellation.
Cancelling the source order does not reverse stock that has already shipped or been received, and it does not automatically close the destination purchase order. If work has already started, reconcile the physical stock, source order, purchase order, and stock movements before making any corrections.
## Reconcile the transfer
Use the shared `XFER-...` reference as the reconciliation key for operational checks.
1. Open **Purchase Orders > Transfers** and click **Refresh**.
2. Confirm the source and destination accounts, transfer role, and current status.
3. Compare the source order quantities with what was actually shipped in the source account.
4. Compare the purchase order's ordered and received quantities with what physically arrived in the destination account.
5. Investigate any difference before marking the purchase order as fully received.
6. Use stock movement and process logs to investigate an unexplained variance. Make a stock adjustment only when you have confirmed the physical quantity and the reason for the correction.
An ordinary stock movement within either warehouse does not update the linked source order, destination purchase order, or inter-warehouse transfer status.
## Troubleshooting
### The destination warehouse is not listed
Confirm that the destination:
* Is a different account in the same Starshipit parent and child account family.
* Has Starshipit WMS enabled.
* Is a full warehouse account that your current account can access, rather than a linked user account.
Refresh the Transfers page after correcting the account setup.
### The destination is missing one or more SKUs
The error lists the SKUs that do not have a matching destination product. Sync or create those products in the destination WMS account, confirm the SKU values match, then create the transfer again.
### The destination address cannot be loaded
Review the sender address in the destination Starshipit account. Complete any missing address details, save the account settings, and retry the transfer.
### The transfer stays on Waiting on webhook
1. Click **Refresh** under **Recent Transfers**.
2. Search for the `XFER-...` order in the source Starshipit account.
3. Check **System > Process Logs** in the source WMS account for order import warnings, including missing product or account-scope issues.
4. Resolve the import warning, then retry the eligible process action or wait for the order to import.
Do not create another transfer while the source order already exists. This can create duplicate outbound work.
### Creation failed but a source order exists
The source Starshipit order is created before the linked destination purchase order and transfer record. If a later step fails, the error identifies the source order that may need manual cleanup.
Search both accounts for the order's `XFER-...` reference. If the source order exists without a destination purchase order, cancel or remove the orphaned source order using your normal order process before retrying. Contact Starshipit support if you cannot confirm which records were created.
### The source order cannot be released
Creating a transfer does not check or reserve source stock. Review the source order's allocation warning and available inventory. Receive, move, or correct the required stock before trying to release the order again.
### The transfer status looks out of date
Click **Refresh**, then check the source order and destination purchase order directly. If their statuses are correct but the transfer summary still differs, use the `XFER-...` reference when contacting Starshipit support.
## Related articles
* [Starshipit WMS orders and allocation](/articles/14700000000010-starshipit-wms-orders-and-allocation)
* [Packing and shipping orders](/articles/14700000000012-packing-and-shipping-orders)
* [Receiving stock](/articles/14700000000008-receiving-stock)
* [Products and inventory configuration](/articles/14700000000006-starshipit-wms-products-and-inventory-configuration)
* [Stock integrity and adjustments](/articles/14700000000020-stock-integrity-and-adjustments)
---
# Sync exploding bundle availability to Shopify
URL: https://support.starshipit.com/articles/14700000000048-sync-exploding-bundle-availability-to-shopify
Canonical: https://support.starshipit.com/articles/14700000000048-sync-exploding-bundle-availability-to-shopify
Markdown: https://support.starshipit.com/articles/14700000000048-sync-exploding-bundle-availability-to-shopify.md
Updated: 2026-07-28
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Keep each exploding bundle's Shopify availability aligned with sellable component stock and open WMS order demand.
Turn on **Exploding bundles** to make WMS manage each bundle parent's Shopify available quantity. This setting is off by default and works independently of **Auto Writeback**, including when orders remain pending.
## Before you begin
Make sure:
* You have imported products from the Shopify store into WMS.
* The bundle parent is linked to a Shopify inventory item.
* The product is configured as an **exploding bundle** with valid components in WMS.
* You know which Shopify location WMS should update.
:::important
When you enable this setting, WMS becomes the source of truth for each linked exploding bundle parent's available quantity at the selected Shopify location. WMS will overwrite changes made directly to that quantity in Shopify when the next update runs.
:::
## How WMS calculates bundle availability
WMS calculates how many complete bundles you can sell from the component stock in sellable WMS locations. It also subtracts component demand from orders with a **Pending** or **Released** status.
For each bundle, WMS:
1. Finds the sellable quantity of each component.
2. Subtracts demand from pending and released orders, including direct component sales and other exploding bundles.
3. Divides each remaining component quantity by the number required for one bundle.
4. Uses the lowest whole-number result as the bundle's available quantity.
5. Sets the bundle parent's Shopify available quantity to that result.
For example, a bundle requires two units of Component A and one unit of Component B:
| Component | Sellable stock | Pending and released demand | Stock remaining | Complete bundles |
| --- | ---: | ---: | ---: | ---: |
| Component A | 20 | 4 | 16 | 8 |
| Component B | 8 | 3 | 5 | 5 |
WMS writes an available quantity of **5** to the Shopify bundle because Component B is the limiting component.
:::note
Pending orders reduce bundle availability because they already claim component stock in WMS. You do not need to enable automatic order release for this setting to work.
:::
## Enable exploding bundle availability sync
1. Go to **System > Settings**.
2. Open **Inventory Writeback** under **Products & Inventory**.
3. Find the Shopify store you want to configure.
4. Select the Shopify **Writeback Location** that WMS should update.
5. Turn on **Exploding bundles** for that store.
WMS queues an initial calculation when you enable the setting. It recalculates bundle availability after relevant stock, order demand, stock count, and bundle configuration changes.
## Understand Auto Writeback
**Exploding bundles** and **Auto Writeback** are separate settings:
| Setting | What WMS updates |
| --- | --- |
| **Exploding bundles** | Sets each linked exploding bundle parent's Shopify available quantity from WMS component stock and open order demand. |
| **Auto Writeback** | Sends normal WMS stock movements for linked products to Shopify. |
You can enable **Exploding bundles** while leaving **Auto Writeback** off. This lets Shopify continue managing normal item inventory while WMS manages the derived availability of exploding bundle parents.
## Verify the setting
1. Open an exploding bundle product in Shopify and note its available quantity at the selected location.
2. Create or update a pending WMS order that uses one of the bundle's components.
3. Wait a few seconds for the background update to run.
4. Refresh Shopify and confirm the bundle parent's available quantity reflects the remaining component stock.
If the quantity does not update, go to **System > Process Logs** and search for Shopify inventory sync errors.
## Troubleshooting
| Problem | What to check |
| --- | --- |
| The **Exploding bundles** switch is unavailable | Select a **Writeback Location** first. Make sure products have been imported from the Shopify store. |
| A bundle does not update | Confirm it is an exploding bundle, the parent is linked to Shopify, and Shopify writeback is not disabled on the product. |
| Availability is lower than expected | Check pending and released orders. Direct sales of a shared component also reduce every bundle that needs that component. |
| Availability is zero | Check that every required component has enough sellable stock after open order demand. Also check the bundle component quantities. |
| Component products are not updating in Shopify | Enable **Auto Writeback** if you also want WMS to send normal component stock movements. |
## Related articles
* [Set up Shopify with Starshipit WMS](/articles/14700000000018-set-up-shopify-with-starshipit-wms)
* [Configure products, bundles and inventory](/articles/14700000000006-starshipit-wms-products-and-inventory-configuration)
* [Manage orders and allocation in WMS](/articles/14700000000010-starshipit-wms-orders-and-allocation)
---
# Inspect, restock, quarantine or write off returned stock
URL: https://support.starshipit.com/articles/14700000000046-inspect-restock-quarantine-or-write-off-returned-stock
Canonical: https://support.starshipit.com/articles/14700000000046-inspect-restock-quarantine-or-write-off-returned-stock
Markdown: https://support.starshipit.com/articles/14700000000046-inspect-restock-quarantine-or-write-off-returned-stock.md
Updated: 2026-07-20
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Decide how to handle stock after a return is received, including moving it to sellable stock, quarantine, or a write-off workflow.
Processing a return adds stock to the selected WMS location. Inspect the item before making it available for another order.
## Choose the right outcome
| Inspection result | What to do |
| --- | --- |
| The item is sellable | Move it from the returns location to normal storage or a pick face. |
| The item needs review, repair or supplier approval | Keep it in a quarantine location so it is not allocated to new orders. |
| The item cannot be sold | Record the approved write-off using your stock adjustment process. |
## Move stock after inspection
Use the standard stock movement workflow to move approved stock into its sellable location. Check the product, quantity and destination before confirming the movement, then verify the stock is available in [View inventory and stock levels](/articles/14700000000014-inventory-dashboard-and-stock-visibility).
For unsellable items, only complete a stock adjustment once the responsible person has approved the reason and quantity. [Adjust stock and investigate stock movements](/articles/14700000000020-stock-integrity-and-adjustments) explains how to keep the audit trail clear.
:::important
Do not move uninspected returns directly to a pick face. Keeping them in returns or quarantine until inspection avoids allocating potentially damaged stock to a new order.
:::
---
# Manage order cancellations, refunds and returns in WMS
URL: https://support.starshipit.com/articles/14700000000060-manage-order-cancellations-refunds-and-returns-in-wms
Canonical: https://support.starshipit.com/articles/14700000000060-manage-order-cancellations-refunds-and-returns-in-wms
Markdown: https://support.starshipit.com/articles/14700000000060-manage-order-cancellations-refunds-and-returns-in-wms.md
Updated: 2026-09-01
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Keep orders and stock aligned when you cancel, edit, refund, or return an order that has reached Starshipit WMS.
Manage order changes in the system where the change starts, then check the resulting work in Starshipit WMS. The correct flow depends on whether warehouse processing has started and whether the order has shipped.
## Before you begin
Make sure:
* The sales channel or order management system is connected to Starshipit and the order has imported into WMS.
* The integration is configured to import the order statuses produced by edits or refunds.
* Your team has agreed on a cut-off for customer-service changes. The safest cut-off is before an order is released in WMS.
* Your role allows you to manage fulfilment and returns in WMS.
* If returned stock needs inspection and automatic inventory writeback is enabled, the return or quarantine location must map to non-sellable platform inventory. If your integration cannot exclude quarantined stock, inspect the item before processing its WMS return so you can use its final sellable or write-off path.
:::important
When cancelling or refunding an unshipped item, restore platform stock when the item remains sellable. For a return against a fully shipped order, wait until the item has arrived and passed inspection before restoring sellable platform stock.
:::
## Choose the correct workflow
| Situation | Start in | What happens in WMS |
|---|---|---|
| Cancel an unfulfilled order | The source platform | The order is removed. Any reserved stock and active work are released. |
| Add an item to an unfulfilled order | The source platform | The updated order returns to **Pending** when it still matches the Starshipit import settings. |
| Remove or refund an item before shipping | The source platform | The updated order returns to **Pending** when it still matches the Starshipit import settings. |
| Return an item from a fully shipped order | The source platform, then WMS | The source platform records the customer refund or return. WMS receives the physical stock against the shipped order. |
## Cancel an unfulfilled order
1. Check the order in WMS to see whether warehouse work has started or stock has moved.
2. Open the order in the source platform.
3. Cancel and refund the order as required. If stock has moved, do not restore platform stock yet.
4. Confirm the order is removed from Starshipit and WMS.
5. If stock has moved, open **Jobs > Putaway** and complete the putaway job created for the order.
6. Restore platform stock when the items remain sellable and are available in WMS storage again.
For a **Pending** order, WMS removes the order without creating warehouse work. For a released order, WMS releases its reservations and removes the related pick or pack jobs.
If stock has already moved to a cart, tote, or packing bench, WMS creates putaway work from that location. Complete the putaway before treating the units as available in their pick face again. Stock that has not left its storage location does not need putaway.
## Add an item before shipping
1. Add the item to the unfulfilled order in the source platform.
2. Complete any payment or approval required by the platform.
3. Wait for the updated order to return to Starshipit and WMS.
4. Confirm the added item and quantity in the **Pending** WMS order.
5. Complete any putaway work created for stock that was already picked or moved to a packing bench.
6. Release the updated order when the warehouse is ready to process it again.
An edited order may temporarily disappear if its new status does not match the integration's import settings. Do not release it until the change is complete and the correct order has returned to **Pending** in WMS.
## Remove or refund an item before shipping
1. Check the order in WMS to see whether the item has moved from storage.
2. Remove or refund the item in the source platform. If it has moved, do not restore platform stock yet.
3. Wait for the updated order to return to **Pending** in WMS.
4. Confirm the refunded item is no longer on the WMS order.
5. Complete any putaway work created for stock already on a cart, tote, or packing bench.
6. Restore platform stock when the item remains sellable and is available in WMS storage again.
7. Release the updated order when it is ready for fulfilment.
If the order's new status is excluded by the integration's import settings, the order may be removed from Starshipit and WMS instead of returning with the updated items.
## Return a fully shipped order
Use this workflow only when the WMS order has a **Shipped** status. Orders with a **Partially Shipped** status do not appear in **Returns**. Complete the outstanding fulfilment first. If it cannot be completed, contact Starshipit Support for next steps instead of making a manual inventory adjustment.
Record the customer-facing return in the source platform, then receive the physical stock in WMS.
1. Process the return or refund in the source platform. If the item has not arrived and passed inspection, do not restore its sellable stock yet.
2. Go to **Returns** in WMS.
3. Select the shipped order.
4. Enter the returned quantities and destination locations.
5. For an uninspected item, choose a returns or quarantine location only when it is excluded from sellable platform stock. Otherwise, inspect the item before continuing and choose its final sellable destination or **Returns/Damaged** for write-off.
6. If an unsellable item will temporarily count towards sellable platform stock, stop other inventory work and turn off automatic inventory writeback.
7. Process the return in WMS. Immediately complete the negative stock adjustment when the item must be written off and cannot remain in an excluded location.
8. If you paused automatic writeback, turn it on again after the final WMS quantity is correct. Reconcile the returned product with a manual inventory sync, then verify the platform quantity.
9. Confirm that only items accepted as sellable are included in the platform's sellable stock.
Follow [Process returns in WMS](/articles/14700000000019-processing-returns) for batch, serial, bundle, partial-return, and destination-location instructions.
## Shopify example
For Shopify orders:
* For an unfulfilled cancellation or refund, leave **Restock** selected when the item remains sellable and has not moved from WMS storage. If it has moved, clear **Restock** and restore Shopify inventory after putaway.
* For a return from a fully shipped order, select **Restock** only if the item has already arrived and passed inspection. Otherwise, restore Shopify inventory after the item is accepted as sellable in WMS.
* Configure the Starshipit Shopify import settings to include **Paid** and **Partially Refunded**. Open the Shopify settings in the Starshipit Classic web interface when you need to select both statuses. This refers to the Starshipit interface, not the Shopify integration version.
* If **Auto Writeback** remains on during inspection, enable **Location buckets** so quarantine, quality control, and damaged-return stock does not write back as sellable Shopify inventory.
* Adding an item usually changes the order to **Partially Paid** until the customer pays the balance. Wait for the order to return as **Paid** instead of importing an incomplete order.
* A refunded item can return on the updated order only when **Partially Refunded** is included in the import settings.
Go to **Settings > Integrations > Shopify Settings** to review the status filter. See [Configure Shopify order import](/articles/90200000000204-configure-shopify-order-import) for the available options, and [Set up Shopify with Starshipit WMS](/articles/14700000000018-set-up-shopify-with-starshipit-wms) for inventory writeback and location buckets.
## Verify the result
After a cancellation, edit, refund, or return:
1. Check the order status and items in the source platform.
2. Check whether the order is absent, **Pending**, **Shipped**, or **Returned** as expected in WMS.
3. Open **Jobs > Putaway** and complete any work created for stock already moved from storage.
4. Check the product and location quantities on the **Inventory** dashboard.
5. Review **System > Process Logs** if the order does not update or commerce inventory writeback does not complete.
## Troubleshooting
| Problem | What to check |
|---|---|
| An edited or refunded order does not return | Confirm its new status is included in the integration's import settings. |
| An edited order is missing while payment or approval is outstanding | Complete the required action in the source platform, then wait for the eligible order to import again. |
| Picked stock is not back in its pick face | Complete the putaway job created from the cart, tote, or packing bench. |
| Platform and WMS stock do not match | Check whether platform stock was restored before or after the item passed inspection. Compare the WMS inventory and process logs before making a stock adjustment. |
| A fully shipped order does not accept an item update | Use the WMS **Returns** workflow. Orders must have a **Shipped** status to appear there. |
## Related articles
* [Process returns in WMS](/articles/14700000000019-processing-returns)
* [Set up WMS returns and quarantine locations](/articles/14700000000045-set-up-wms-returns-and-quarantine-locations)
* [Manage orders and allocation in WMS](/articles/14700000000010-starshipit-wms-orders-and-allocation)
* [Understand WMS integrations](/articles/14700000000044-understand-wms-integrations)
---
# Set up WMS returns and quarantine locations
URL: https://support.starshipit.com/articles/14700000000045-set-up-wms-returns-and-quarantine-locations
Canonical: https://support.starshipit.com/articles/14700000000045-set-up-wms-returns-and-quarantine-locations
Markdown: https://support.starshipit.com/articles/14700000000045-set-up-wms-returns-and-quarantine-locations.md
Updated: 2026-07-20
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Create the locations and process rules your team needs to receive, inspect, quarantine, and restock returned stock.
Set up return locations before your team begins processing returned orders. A clear location structure stops uninspected stock from becoming available for new orders.
## Create the locations you need
Create locations that match your physical returns process. Most warehouses need at least:
| Location | Use it for |
| --- | --- |
| **Returns receiving** | Newly returned items waiting for a check. |
| **Quarantine or damaged** | Items that cannot be sold until inspected, repaired or approved. |
| **Sellable storage or pick face** | Items that have passed inspection and can be put back into normal stock. |
| **Write-off area** | Items that will be disposed of or removed from available inventory. |
Use [Set up warehouse locations and work areas](/articles/14700000000033-starshipit-wms-locations-and-warehouse-setup) to create and label the locations. Make the physical labels match the names and barcodes in WMS.
## Decide your default return flow
Choose the destination based on the item’s condition:
* Send unchecked items to **Returns receiving** or **Quarantine**.
* Send approved items to a sellable location only after inspection.
* Keep damaged or unsellable items in a controlled location until they are written off or otherwise resolved.
Document who can approve a stock adjustment or write-off. This gives the warehouse team a clear hand-off when a return cannot be restocked.
## Next step
When a parcel arrives, follow [Process returns in WMS](/articles/14700000000019-processing-returns). After inspection, use [Inspect, restock, quarantine or write off returned stock](/articles/14700000000046-inspect-restock-quarantine-or-write-off-returned-stock) to complete the follow-up work.
---
# Process returns in WMS
URL: https://support.starshipit.com/articles/14700000000019-process-returns-in-wms
Canonical: https://support.starshipit.com/articles/14700000000019-process-returns-in-wms
Markdown: https://support.starshipit.com/articles/14700000000019-process-returns-in-wms.md
Updated: 2026-09-01
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Process returned items against a shipped WMS order, update inventory, and complete any inspection, restocking, or write-off follow-up.
Use the dedicated **Returns** workflow to receive items against a shipped WMS order. WMS records how much was returned, adds the stock to your selected location, and keeps the return linked to the original order.
## Before you begin
Make sure:
* The order has been shipped in WMS. Only orders with a **Shipped** status appear in the Returns workflow.
* Your role allows you to manage fulfilment.
* The location where you want to receive the stock already exists. Use a **Returns/Damaged** or **Quarantine** location when an item still needs inspection. You can use a **Pick Face** or **Bulk Storage** location when the item has already been inspected and is ready to sell.
See [Locations and warehouse setup](/articles/14700000000033-starshipit-wms-locations-and-warehouse-setup) to create or review locations.
## Process a return
1. Go to **Returns** in WMS.
2. Select the **Shipped Order**. You can search by order number or reference.
3. Review or change the **Reason** for the return.
4. Enter the **Quantity Returning** for each item. WMS shows the quantity shipped, any quantity already returned, and the quantity that remains returnable. Set the quantity to `0` for items that were not returned.
5. Select a **Target Location** for each item you are receiving.
6. Enter the tracking details shown for the product:
* For a batch-tracked product, enter the **Batch number** and the **Expiry date** when applicable.
* For a serial-tracked product, return one unit at a time and enter its **Serial number**.
* Products without batch or serial tracking do not need additional details.
7. Review any **Bundle Components** shown for an exploding bundle. WMS calculates the component quantities from the number of bundles being returned. Enter batch and expiry details where applicable, or enter the required serial numbers one per line.
8. Choose whether to leave **Mark order as returned** on. This changes the order status from **Shipped** to **Returned** after processing.
9. Review **Total quantity selected**, then click **Process Return**.
The return form keeps the shipped quantities, destination locations, tracking details and final order-status choice together before processing.
:::important
If this is a partial return or you expect more return parcels, turn off **Mark order as returned**. The Returns workflow only lists orders with a **Shipped** status, so mark the order as **Returned** only when you do not need to process another return against it.
:::
## What happens after processing
When the return succeeds, WMS:
* Adds the returned quantity to on-hand inventory at the selected target location.
* Creates stock movement and process log records with the return reason and original order reference.
* Adds the component inventory instead of the bundle SKU inventory for exploding bundles.
* Changes the order status to **Returned** only if **Mark order as returned** was selected.
* Queues inventory writeback for supported connected commerce platforms when automatic writeback is enabled. A writeback failure does not undo the completed WMS return.
## Complete the follow-up work
If you received an item into **Returns/Damaged** or **Quarantine**, inspect it before making it available for another order.
* Move sellable stock to a **Pick Face** or **Bulk Storage** location.
* Keep stock in **Quarantine** while it is being investigated.
* Move unsellable stock to **Returns/Damaged**, then use a separate negative manual adjustment to write it off with the correct reason.
Manual adjustments are for inventory corrections and write-offs. Do not use a positive manual adjustment instead of the Returns workflow when you have a returnable shipped WMS order, because it does not process the return against that order.
## Verify the return
After processing:
1. Check the confirmation message shows the expected line item and unit totals.
2. Check the target location on the **Inventory** dashboard.
3. Review the stock movement or process logs when you need the order reference, reason, quantity, location, batch, or serial audit trail.
4. If commerce inventory writeback is enabled, review **System > Process Logs** if the connected platform does not update as expected.
## Troubleshooting
| Issue | What to check |
|---|---|
| The order does not appear | Confirm the order is in **Shipped** status. Orders already marked **Returned** are not available for another return. |
| **Process Return** is unavailable | Select at least one positive quantity and a target location. Complete any required batch, serial, or bundle component details. |
| WMS rejects the quantity | The quantity cannot exceed the remaining returnable quantity. Serial-tracked products must be returned one unit at a time. |
| The commerce platform did not update | The WMS return can complete before the asynchronous writeback. Check **System > Process Logs** for a skipped or failed inventory sync. |
## Related guides
* [Manage order cancellations, refunds and returns in WMS](/articles/14700000000060-manage-order-cancellations-refunds-and-returns-in-wms)
* [Stock integrity and adjustments](/articles/14700000000020-stock-integrity-and-adjustments)
* [Inventory dashboard and stock visibility](/articles/14700000000014-inventory-dashboard-and-stock-visibility)
* [Understand WMS integrations](/articles/14700000000044-understand-wms-integrations)
---
# Import and export WMS data by CSV
URL: https://support.starshipit.com/articles/14700000000041-import-and-export-wms-data-by-csv
Canonical: https://support.starshipit.com/articles/14700000000041-import-and-export-wms-data-by-csv
Markdown: https://support.starshipit.com/articles/14700000000041-import-and-export-wms-data-by-csv.md
Updated: 2026-09-15
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Use the current Starshipit WMS CSV templates to import products, locations, orders, purchase orders, adjustments, and stocktakes, or export inventory and reports.
Starshipit WMS uses different CSV rules for different workflows. This reference lists the current column order, limits, processing behaviour, and safest way to correct an import.
Always download a fresh template or export from the page where you will import it. Keep the header row unchanged, save the file as CSV, and test a small file before importing a large change.
Import actions accept `.csv` files. A file renamed from another spreadsheet format is not a valid CSV.
## Choose the correct CSV workflow
| Workflow | Import effect | Processing | Current limit |
|---|---|---|---|
| Products | Creates new SKUs and updates matching SKUs | Background | 5 MB and 15,000 data rows |
| Locations | Creates new names and updates matching names | Background | 5 MB; no separate row limit is shown |
| Orders | Creates new orders in the selected Starshipit account | In the page | 1 MB, 50 orders, and 1,000 line items |
| Purchase orders | Creates new purchase orders only | Background | 5 MB; no separate row limit is shown |
| Starting Stock | Stages opening balances; saving adds stock | In the page | Positive whole numbers; one location per SKU |
| Manual stock adjustments | Adds valid rows to the adjustment batch for review | In the page | 5 MB; up to 200 rows per batch, including queued rows |
| Stocktake | Submits valid counts for approval or queues processing if authorised | Background after approval | No separate file or row limit is shown |
| Inventory and stock movements | Export only | In the page | Stock movements: 10,000 rows; inventory has no separate row limit shown |
| Operational reports | Export only | In the page | Some stock reports are limited to 5,000 rows |
:::caution
Importing a stocktake CSV submits its valid counts directly. With `stocktake.approve`, processing is queued immediately; otherwise it awaits approval. It does not create an editable import draft. Verify the file before importing it.
:::
## Product CSV
Go to **Products** and select **Export CSV** to download the safest starting file. The export includes instruction rows beginning with `#`; WMS ignores those rows when you import the file.
The canonical header order is:
```text
sku,name,client,supplier,image,price,unitCost,parentProductSku,conversionQuantity,uomLabel,leadTimeDays,stockWarningLevel,idealStockLevel,barcode,length,width,height,weight,colour,size,materials,countryOfOrigin,manufacturerId,brandName,make,model,usage,dangerousGoods,description,hsCodes,trackingType,allocationRule,productType,bundleExplosionMode,bundleComponentSkus,bundleComponentQuantities
```
### Required product values and relationships
| Column | Rule |
|---|---|
| `sku` | Required and unique. A matching SKU updates the existing product; a new SKU creates a product. |
| `name` | Required. |
| `client` | For a 3PL account, enter an existing client name. A blank value removes the product's client assignment. Product import is not available to client-scoped users. |
| `supplier` | Enter one existing, unambiguous supplier name. A blank value removes the supplier assignment. Product import does not create suppliers. |
| `parentProductSku` | The parent can already exist or appear elsewhere in the same file. Parent and child products must belong to the same client. A blank value removes the parent relationship. |
| `conversionQuantity` | Optional. Use a whole number of at least `1`; blank defaults to `1`. |
| `uomLabel` | Optional. Use the unit-of-measure label, for example `EACH`, `CARTON`, or `PALLET`; blank defaults to `EACH`. |
| `trackingType` | Optional. Use `NONE`, `BATCH`, or `SERIAL`; blank defaults to `NONE`. |
| `allocationRule` | Optional. Use `FIFO`, `LIFO`, `SPECIFIC`, `FEFO`, or `LEFO`; blank uses the account default. |
| `productType` | Optional. Use `STANDARD` or `BUNDLE`; blank defaults to `STANDARD`. |
| `bundleExplosionMode` | Optional for bundles. Use `EXPLODE` or `REQUIRE_STOCK`. |
| `bundleComponentSkus` | For bundles, enter component SKUs as a comma-separated list inside one quoted CSV cell. Components can appear in the same file and must belong to the same client as the bundle. |
| `bundleComponentQuantities` | Enter quantities in the same order as `bundleComponentSkus`, also inside one quoted CSV cell. |
Other important formats are:
* `countryOfOrigin` uses a two-letter country code.
* `hsCodes` uses comma-separated `COUNTRY:CODE` values, or `GLOBAL:CODE` for a global code.
* `stockWarningLevel` and `idealStockLevel` cannot be negative. The ideal level cannot be lower than the warning level.
* Prices and dimensions use plain numbers without currency symbols or unit text.
Product imports run in the background in groups of rows. The progress notification shows processed, created, updated, and failed rows. You can minimise it and continue working. If you cancel, rows already processed remain created or updated.
Only one product import can be active for an account at a time. If one is already running, WMS reconnects you to that import instead of starting a second run.
## Location CSV
Go to **Locations** and select **Export CSV**. The exported file includes the current locations and instruction rows beginning with `#`.
The canonical header order is:
```text
name,parentLocationName,barcode,type,zoneCode,zoneName,sequence,minCapacity,maxCapacity,defaultStocktake,allowMixedClientStock,allowedSkus
```
| Column | Rule |
|---|---|
| `name` | Required and unique. A matching name updates the existing location; a new name creates a location. |
| `parentLocationName` | The parent can already exist or appear elsewhere in the same file. Missing parents and circular relationships fail validation. |
| `type` | Use `PICK_FACE`, `BULK_STORAGE`, `STAGING_DOCK`, `PACKING_BENCH`, `EQUIPMENT`, `QUALITY_CONTROL`, `RETURNS_DAMAGED`, `SHIPPING_DOCK`, `CROSS_DOCK`, `QUARANTINE`, `OVERFLOW`, `TOTE`, or `CONTAINER`. |
| `zoneCode` and `zoneName` | Refer to an existing active zone. If both are supplied, they must identify the same zone. The import does not create zones. |
| `sequence` | Use a whole number of `0` or greater. |
| `minCapacity` and `maxCapacity` | Use whole numbers of `0` or greater. Minimum capacity cannot exceed maximum capacity. |
| `defaultStocktake` | Use `true` or `false`. |
| `allowMixedClientStock` | Use `true` to allow products for different 3PL clients in the location, or `false` to prevent mixing clients. |
| `allowedSkus` | Enter existing SKUs separated by semicolons, for example `SKU-1;SKU-2`. |
Location imports run in the background. WMS resolves parent locations before their children, even when the parent is later in the file. The progress notification shows created, updated, and failed rows. If you cancel, locations already processed remain changed.
For updates, start from a fresh export and change only the intended cells. Do not assume that clearing an optional cell removes its existing value.
## Order CSV
Go to **Orders**, select **Import CSV**, then download the template. Choose the Starshipit account that should own the orders when you import the completed file.
The canonical header order is:
```text
orderReference,recipientName,email,phone,company,building,street,suburb,city,state,postCode,country,deliveryInstructions,sku,quantity
```
Each row is one order line. Repeated `orderReference` values are grouped into one order and must use the same delivery details. `orderReference`, `recipientName`, `street`, `city`, `postCode`, `country`, `sku`, and a positive whole-number `quantity` are required.
WMS submits each valid order to the selected Starshipit account separately. If an import has both submitted and failed orders, create a new CSV containing every row for only the failed `orderReference` groups. Correct those groups and import the retry file; do not include order references that were already submitted.
## Purchase order CSV
Go to **Purchase Orders** and select **CSV Template**. When importing, choose whether WMS should create the purchase orders as **Draft** or **Created**.
The canonical header order is:
```text
poNumber,supplierName,productSku,quantity,price
```
All five values are required on every row.
| Column | Rule |
|---|---|
| `poNumber` | Groups rows into one purchase order. The number must not already exist in WMS. |
| `supplierName` | All rows for one purchase order must use the same supplier. WMS uses an existing case-insensitive name match, or creates the supplier when no match exists. |
| `productSku` | Must match an existing product SKU. Products are not created by this import. |
| `quantity` | Use a positive whole number. |
| `price` | Use a number of `0` or greater, without a currency symbol. |
The purchase-order import is create-only: it never updates an existing purchase order. Each row is a line item, and repeated `poNumber` values are combined into one purchase order. If any line for a purchase order is invalid, that purchase order is skipped; other valid purchase orders in the file can still be created.
The import runs in the background and reports progress by purchase order. If you cancel, purchase orders already created remain in WMS.
:::note
Use **Draft** when the imported purchase orders need review. Use **Created** when they are ready for receiving.
:::
## Starting Stock CSV
Go to **Getting started > Bring stock in > Add starting stock**, or reopen **Help > Setup Guide** after onboarding. The [direct Starting Stock page](https://wms.starshipit.com/dashboard/setup/starting-stock) requires `inventory.adjust`.
Select **Have a lot of stock? Import via CSV instead**, then **Download a pre-filled template with your products**. WMS automatically fetches all product pages; no manual paging is required. The download is `starting-stock-template.csv`:
```text
sku,product_name,quantity,location
```
Use positive whole-number opening balances and one existing location per SKU. Importing stages the values; **Save starting stock** adds them to existing inventory. Saving the same balances twice adds them twice, and there is no user-facing undo. Use Stock Adjustments for batch-, serial-, multi-location, or corrective changes.
See [Migrate starting stock and cut over to Starshipit WMS](/articles/14700000000049-migrate-starting-stock-and-cut-over-to-starshipit-wms) for field matching, rehearsal, and reconciliation.
## Manual stock adjustment CSV
Go to **Inventory > Stock Adjustments > Adjustments**. Add a representative adjustment using **Add adjustment to batch** and select **Export batch (count) (CSV)** to export the queued batch, then edit that file and select **Import CSV**. There is no standalone blank adjustment template.
Each batch supports up to 200 rows, including existing drafts. Import files must be 5 MB or smaller. Split larger corrections into separate batches.
The canonical header order is:
```text
sku,productName,trackingType,quantityChange,reason,locationName,fromLocationName,toLocationName,batchNumber,expiryDate,serialNumber,reference
```
| Column | Rule |
|---|---|
| `sku` | Required. Must match an existing product. |
| `quantityChange` | Required. Use a non-zero whole number. A positive value adds stock; a negative value removes stock. |
| `reason` | Required. Must match a configured adjustment reason. |
| `locationName` | Required. Must match an existing location. This is the location where stock is added or removed. |
| `fromLocationName` | Optional for a positive adjustment when recording where the stock came from. |
| `toLocationName` | Optional for a negative adjustment when recording where the stock is going. |
| `batchNumber` | Required for a batch-tracked product. |
| `expiryDate` | Optional for a batch-tracked product. Use `DD-MM-YYYY`. |
| `serialNumber` | Required for a serial-tracked product. A serial adjustment must be `1` or `-1`. |
WMS validates the file in the page and adds valid rows to the current adjustment batch. Invalid rows are skipped and shown as errors. Importing does not change inventory until you review the batch and select **Submit adjustments**.
Imported rows are added to any rows already in the batch. Clear duplicate drafts before importing, and do not import the same correction twice. When submitting a batch, successful rows are removed and failed rows remain for correction.
## Stocktake CSV
Go to **Inventory > Stocktakes**. On a **By Product** stocktake, select the products and then select **Export stocktake (CSV)**. Keep the identifying columns from that export and enter the physical counts in `countedQuantity`.
The canonical header order is:
```text
sku,name,trackingType,locationName,batchNumber,serialNumber,expiryDate,countedQuantity
```
The file can include instruction rows beginning with `#`; WMS ignores those rows on import.
| Product tracking | How to enter the count |
|---|---|
| Standard | Use one row for the product. `countedQuantity` is the total physically counted. |
| Batch | Use one row for each location and batch number. Keep the exported expiry date in `YYYY-MM-DD` format when applicable. |
| Serial | Use one row for each serial number. Set `countedQuantity` to `1` when the serial exists, or remove the row when it does not. |
`countedQuantity` is required and cannot be negative. Keep location names exactly as exported so WMS can match them. Tracked products require their batch or serial detail.
Select **Import CSV** to validate and submit the counts directly. Unknown SKUs or invalid rows can be skipped while valid rows are submitted, so check every warning. Unknown location names, missing required locations for positive counts, or missing tracked-product details block submission; correct the file before retrying.
There is no editable import draft or separate save step. With `stocktake.approve`, the submitted counts are queued for processing immediately. Otherwise, they remain **Awaiting approval** under **Inventory > Stocktakes**. After approval, use **View background work** from the confirmation or go to **Operations > Background Work** to confirm processing completed, then verify inventory and stock movements before preparing another stocktake.
To correct a stocktake, create a new stocktake export from the current inventory and prepare a corrected count. Do not reuse an old file after stock has changed. For a known one-off correction, use a [manual stock adjustment](/articles/14700000000020-stock-integrity-and-adjustments) instead.
**Count as you go** has a separate raw CSV export with these columns:
```text
sku,name,trackingType,locationName,batchNumber,serialNumber,expiryDate,countedQuantity,notes,groupedPreviousQuantity,groupedCountedQuantity,groupedVariance
```
That file is an export of the count session; there is no matching Count as you go CSV import action.
## Inventory exports
Go to **Inventory** and select **Export inventory**. The export uses the current inventory view and filters. It is a point-in-time snapshot and cannot be imported back into WMS.
The product view exports:
```text
Product SKU,Product Name,Tracking,Quantity On Hand,Quantity Committed,Quantity Allocated,Quantity Available,Quantity Incoming,Avg Unit Cost,Stock Value,UOM
```
The location-detail view exports:
```text
Product SKU,Product Name,Tracking,Location,Location Type,Batch Number,Serial Number,Expiry Date,Quantity On Hand,Unit Cost,On Hand Value,Country of Origin,UOM,Last Updated
```
## Stock movement exports
Go to the stock movement log, apply the required product, location, reason, tracking, date, or search filters, then export the filtered view.
The canonical header order is:
```text
SKU,Product,Reason,Reference,Location,From Location,Batch Number,Serial Number,Expiry Date,Change,Timestamp
```
An export is limited to 10,000 rows. If more rows match, narrow the filters and export again. Stock movement CSVs are audit exports and cannot be imported.
## Operational report exports
Operational reports export the report's current date range and filters. They are read-only snapshots and cannot be imported into WMS.
| Report | Canonical data columns | Export limit |
|---|---|---|
| Fulfilment Reporting | `Date`, `Order Number`, `Reference`, `Completed By`, `Shipping Cost`, `Total Units`, `Total Packages`, `Package Types`, `Items` | No separate row limit shown |
| Packing Bench Reporting | `Completed Date`, `Packing Bench`, `Pack Job`, `Orders`, `References`, `Assigned User ID`, `Duration`, `Order Count`, `Unit Count` | No separate row limit shown |
| PO Receipt Reporting | `Received Date`, `PO Number`, `Supplier`, `Status`, `Lines`, `Items`, `Cartons`, `Received Value`, `Avg Unit Cost` | No separate row limit shown |
| Expiring Stock | `SKU`, `Product`, `Client`, `Location Type`, `Location`, `Batch`, `Serial`, `Expiry Date`, `Days Until Expiry`, `Quantity On Hand` | 5,000 rows |
| Slow-Moving Stock | `SKU`, `Product`, `Client`, `Location Type`, `Location`, `Quantity On Hand`, `First Received Date`, `Last Received Date`, `Last Dispatched Date`, `Last Movement Date`, `Stock Age Days`, `Days Since Last Dispatch`, `Days Since Last Movement` | 5,000 rows |
| Pick Face Replenishment | `SKU`, `Product`, `Client`, `Zone`, `Pick Face`, `Minimum`, `Target`, `Pick Face Quantity`, `Pick Face Allocated`, `Pick Face Available`, `Shortfall To Minimum`, `Suggested Replenishment`, `Bulk Available`, `Fulfillable From Bulk`, `Open Replenishment Jobs`, `Open Replenishment Quantity` | 5,000 rows |
| Replenishment Jobs | `Job ID`, `Job Name`, `Status`, `Priority`, `Assigned User`, `SKU`, `Product`, `Client`, `Destination`, `Zone`, `Replenishment Quantity`, `Allocated Quantity`, `Picked Quantity`, `Source Locations`, `Created At`, `Started At`, `Completed At` | 5,000 rows |
| Declared Value vs COGS | `Movement ID`, `Timestamp`, `Client`, `Order / Reference`, `SKU`, `Product`, `Signed Quantity`, `Unit Cost`, `Signed Total COGS`, `Cost Availability`, `Declared Unit Value`, `Declared Value Currency`, `Signed Declared Value`, `Signed Declared Value Difference`, `Declared Value Availability` | 10,000 movements |
Some report CSVs add summary sections after the data rows. Keep those sections out of any separate system import unless that system explicitly supports them.
Product Traceability currently provides Excel and PDF exports rather than a customer-facing CSV action.
## Fix validation errors and retry safely
Product, location, order, and purchase-order imports can finish with a mixture of successful and failed records. A file-level or header validation failure stops the import before row processing starts. Once row processing starts, successful records remain changed even when other records fail.
Open the completed import notification, review the error list, and keep a copy before closing it. The stored message list for these background imports is capped at 50 messages, so fix the repeated cause before retrying.
Use the retry approach for the workflow:
* **Products:** fix failed rows and import them again. Matching SKUs update, so a retry is safe when the corrected file contains only the intended products.
* **Locations:** fix failed rows and import them again. Matching location names update. Use a current export so you do not overwrite another change.
* **Orders:** remove every order reference that was submitted, then retry only failed `orderReference` groups. Include every line for each failed order so its complete item list is submitted once.
* **Purchase orders:** remove every purchase order that succeeded, then retry only failed `poNumber` groups. Re-importing the full file fails for the purchase orders already created.
* **Manual adjustments:** correct only the drafts that remain after submission. Do not recreate successful adjustments because adjustments are additive.
* **Stocktakes:** start from a new export of current inventory, then import the corrected physical counts. Use a manual adjustment for a small, known correction.
Common errors include a changed or missing header, duplicate identifiers, unknown product SKUs, missing parent records, invalid client relationships, unknown locations or zones, invalid tracked-stock detail, and numbers outside the allowed range.
## Keep CSV files safe in spreadsheets
* Save as **CSV UTF-8**. Do not save as an Excel workbook and rename the extension.
* Keep leading zeroes in SKUs, barcodes, batch numbers, serial numbers, and references by formatting those columns as text before editing.
* Turn off automatic date conversion for identifiers and use the date format required by the template.
* Do not add title rows, merged cells, formulas, totals, hidden headings, or a second header row.
* If a value contains a comma, quote, or line break, let the spreadsheet application quote the CSV cell. Do not split a bundle list into extra columns.
* Treat a text or identifier cell beginning with `=`, `+`, `-`, or `@` as untrusted spreadsheet content. WMS protects text in several exports, but you should still avoid enabling formulas or external links in files from another party. Negative numbers in quantity columns are different and can be valid where the template allows them.
* Reopen the saved CSV in a text editor or import preview and confirm that the header and column count are unchanged.
## Related guides
* [Starshipit WMS products and inventory configuration](/articles/14700000000006-starshipit-wms-products-and-inventory-configuration)
* [Starshipit WMS locations and warehouse setup](/articles/14700000000033-starshipit-wms-locations-and-warehouse-setup)
* [Suppliers and purchase orders](/articles/14700000000007-suppliers-and-purchase-orders)
* [Stocktakes and cycle counts](/articles/14700000000015-stocktakes-and-cycle-counts)
* [Inventory dashboard and stock visibility](/articles/14700000000014-inventory-dashboard-and-stock-visibility)
* [Reporting and insights](/articles/14700000000021-reporting-and-insights)
---
# Use WMS reporting and insights
URL: https://support.starshipit.com/articles/14700000000021-use-wms-reporting-and-insights
Canonical: https://support.starshipit.com/articles/14700000000021-use-wms-reporting-and-insights
Markdown: https://support.starshipit.com/articles/14700000000021-use-wms-reporting-and-insights.md
Updated: 2026-09-14
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Monitor warehouse health, fulfilment throughput, inbound receipts, shipment value and cost, and staff productivity using WMS reporting dashboards.
The **Reporting** area is the central hub for WMS dashboards and exports. Each report focuses on a different lens of warehouse performance:
| Dashboard | What it shows |
|---|---|
| **Operations** | Warehouse health at a glance — active warnings, backlog, and a restocking summary |
| **Fulfilment Report** | Shipped orders, packages, shipment cost, and items; completed-by-user breakdown; CSV export |
| **Packing Bench Reporting** | Completed pack jobs, orders, units, and throughput by packing bench |
| **PO Receipt Report** | Expected and received quantities by PO line, variance, under- or over-receiving, and received value; CSV export |
| **Stock Movements** | Recorded quantity changes by SKU and reporting period, with summary and individual-movement CSV exports |
| **Traceability** | Dispatched batches matched by batch number, order, or customer |
| **Performance** | Fulfilment cycle times, configurable SLA target, and daily trends |
| **Expiring Stock** | Batch-tracked stock approaching expiry |
| **Slow-Moving Stock** | On-hand stock without recent dispatches or movements |
| **Pick Face Replenishment** | Pick faces below minimum stock with suggested replenishment quantities |
| **Replenishment Jobs** | Created replenishment jobs with status and source details |
| **Declared Value vs COGS** | Shipment-time declared item values compared with auditable cost of goods sold |
| **Backlog & WIP Aging** | Unshipped orders grouped by age, with active workflows and known hold or job blockers |
| **Slotting & Utilization** | Storage occupancy, capacity coverage, mixed-SKU locations, and products spread across pick faces |
| **Shipping Economics** | Shipping spend, cost coverage, average cost per shipment or unit, and package usage |
| **Staff Management** | Staff activity, picks/hour, packs/hour, peak-hour patterns, and per-user detail |
Some report cards show a readiness message. Use it to identify missing setup or data, such as storage locations without a maximum capacity or reports that do not yet have qualifying activity.
## Operations dashboard
The **Operations dashboard** ([wms.starshipit.com/dashboard/operations](https://wms.starshipit.com/dashboard/operations)) gives you a real-time health check of your warehouse. It shows:
* **Active warnings** — issues that need attention, such as orders with insufficient stock or integration errors.
* **Backlog** — orders that are pending or overdue.
* **Shipment anomalies** — flagged deliveries or fulfilment exceptions.
* **Paused jobs** — jobs that are blocked or waiting for follow-up.
* **Insufficient stock** — a count of orders that cannot currently be allocated due to zero or negative available stock.
* **Restocking summary** — how many products are at or near stockout, with a link to the full [Restocking Insights](/articles/14700000000017-restocking-insights) dashboard.
* **Fulfilment summary** — a snapshot of orders picked, packed, and shipped today.
Use this dashboard at the start of each day to identify anything that needs attention before the team starts work.
## Fulfilment report
The **Fulfilment Report** shows outbound performance over a selected date range:
* **Shipped orders** — total orders shipped in the period
* **Packages** — total shipping parcels created
* **Items shipped** — total item lines fulfilled
* **Shipment cost** — carrier cost information where available from the shipment record
* **Completed by user** — a breakdown of fulfilment activity by staff member, showing who picked and packed which orders
This report is available as a **CSV export**, making it easy to share with a team lead, use in a weekly performance review, or import into a spreadsheet for further analysis. Date filters use local warehouse dates so daily reporting lines up with the team working day.
## Stock movements report
Use **Reporting > Stock Movements** to reconcile recorded quantity changes by SKU over a reporting period. You need analytics-view access to open the report and analytics-export access to download its CSV files.
1. Choose a **Reporting period**. The initial view uses the previous complete calendar month in your account's timezone.
2. Select a **Client**, or keep **All permitted clients**.
3. Select **Refresh**, then check the dates and timezone shown above **Item quantities**.
4. Review **Shipped**, **Reversals**, **Other increases**, **Other decreases**, and **Net change** for each SKU.
5. Select **Summary CSV** for per-SKU totals or **Movement CSV** for individual movements, reasons, references and locations.
Refresh after changing filters before exporting. Net change equals reversals plus other increases, minus shipped units and other decreases. Other movements include receipts, assemblies, adjustments and transfers; paired internal transfers net to zero.
The report covers recorded WMS movements, not opening or closing stock balances. Each report is limited to 10,000 movements. If the limit is exceeded, narrow the reporting period or client filter and try again.
## Declared value vs COGS report
Use **Reporting > Declared Value vs COGS** to compare shipment-time declared item values with the cost of goods sold recorded by WMS.
1. Select a **Date range**.
2. Select a **Client**, or leave **All Clients** selected.
3. Select **Refresh**.
4. Review the summary totals and movement details, or select **CSV** to export the filtered report.
Shipments appear as positive quantities. Exact shipment reversals appear as negative quantities. WMS marks a movement as **Uncosted** when it has no recorded unit cost, and marks its declared value as **Unavailable** when the shipped order item has no consistent declared item value and currency.
:::note
Declared value comes from the order's customs item data. It is not sales revenue, tax, payment, invoice, or accounting margin.
:::
## Backlog and work-in-progress aging
Use **Reporting > Backlog & WIP Aging** to find unshipped orders that are waiting or blocked.
The summary groups orders into **Under 24h**, **24–72h**, and **Over 72h** bands. Each row shows the order status, age, remaining units, active workflow, and a known blocker when the order is on hold or has a paused or failed job.
Select a client to narrow the live backlog for a 3PL operation, then use the oldest and blocked rows to decide what needs follow-up first.
## Slotting and location utilization
Use **Reporting > Slotting & Utilization** to review how storage locations are being used.
The report shows empty and occupied locations, stored units, mixed-SKU locations, products spread across multiple pick faces, and locations that exceed their configured maximum capacity. Selecting a client limits the report to locations containing that client's stock. Occupancy and utilization still use all stock you are permitted to see at each shared location, while the listed SKUs follow the selected client.
Occupancy and mixed-SKU results work without capacity settings. To calculate utilization percentages and identify over-capacity locations, configure a **Maximum Capacity** on the relevant storage locations.
## Shipping economics
Use **Reporting > Shipping Economics** to review shipment spend and package usage over a selected date range.
The summary shows shipping cost, cost coverage, order linkage, average cost per shipment, and average cost per unit. Each shipment row includes its order reference, client, units, shipping cost, package count, and known package types.
Coverage messages explain when totals are partial. Shipping-cost totals and averages exclude shipments without cost data. Package analysis is also partial when shipment package records or package types are unavailable.
## PO receipt report
The **PO Receipt Report** shows inbound receiving activity over a selected date range:
* **Received POs** — purchase orders with at least one receipt in the period
* **Supplier and status** — the supplier and current PO status
* **Expected and received quantities** — the ordered quantity and total received quantity for each product line
* **Variance and discrepancy** — whether each line matched, was under-received, or was over-received
* **Received value** — unit cost and total value received in the selected period
Expand a purchase order to review its line-level comparison. The **CSV export** includes PO, supplier, SKU, expected quantity, received quantity, variance, discrepancy, unit cost and received value. Use it to reconcile supplier invoices or identify recurring receiving differences.
## Performance dashboard
The **Performance dashboard** shows fulfilment cycle time metrics — how long it takes from an order being released to it being shipped:
* **Average cycle time** — the mean time from release to ship across all orders in the period
* **Median cycle time** — the middle value, less affected by outliers
* **p90 cycle time** — the 90th percentile, showing what the slowest 10% of orders look like
* **SLA target** — your configured performance target, used to compare actual cycle times against the expected service level
A **daily trend chart** plots cycle times over time, helping you see whether fulfilment is speeding up or slowing down.
Choose **Today**, a rolling 7, 14, 30, 60, or 90-day period, or one calendar date. WMS applies the warehouse account's timezone to day boundaries. Where your permissions allow it, select an order total or performance group to open the matching shipped orders for the selected period.
Users with settings-management access can open the dashboard settings to configure:
* The fulfilment target in business hours.
* The start and end of the warehouse working day.
* The weekdays that count as working days.
* Whether WMS shows the SLA state on active Pending and Released orders.
The default target is 24 business hours, measured from 9:00 am to 5:00 pm, Monday to Friday. Set the warehouse schedule before comparing teams or date ranges so elapsed time excludes the right non-working hours.
Use the performance dashboard to:
* Set benchmarks for your team
* Spot days or weeks where processing slowed and investigate why
* Track improvement after process changes (for example, introducing batch picking or adding a packing bench)
## Stock health reports
Use stock health reports to spot inventory risk before it affects orders:
* **Expiring stock** shows batch-tracked stock that is approaching expiry, helping teams prioritise FEFO picks, promotions, returns to supplier, or write-offs.
* **Slow-moving stock** identifies products that have remained in stock without enough movement over the selected period. Use it to investigate excess inventory, plan promotions or clearance activity, and avoid tying up warehouse space in stock that is not selling.
* **Restocking history window** controls how much sales history is considered when calculating restocking suggestions.
* **Report favourites** let users pin frequently used reports to the dashboard navigation.
## Staff management and productivity
The **Staff Management** section includes productivity metrics for warehouse staff:
* **Active users** — who has been active in the system in the selected period
* **Picks per hour** — picking throughput per team member
* **Packs per hour** — packing throughput per team member
* **Process breakdown** — how time is split between picking, packing, putaway, replenishment and other tasks
* **Peak hours** — when each staff member is most active (useful for scheduling)
Click into an individual staff member to see their **detail sheet**: a timeline of their activity, job completions and productivity metrics.
## Export report data
The **Fulfilment Report**, **PO Receipt Report**, **Stock Movements**, and **Declared Value vs COGS** report support **CSV export**. Filtered stock movement views can also be exported from the stock movement logs.
## Related guides
* [Restocking insights](/articles/14700000000017-restocking-insights)
* [Unified search](/articles/14700000000022-unified-search)
* [Stock integrity and adjustments](/articles/14700000000020-stock-integrity-and-adjustments)
---
# Search WMS records
URL: https://support.starshipit.com/articles/14700000000022-search-wms-records
Canonical: https://support.starshipit.com/articles/14700000000022-search-wms-records
Markdown: https://support.starshipit.com/articles/14700000000022-search-wms-records.md
Updated: 2026-07-22
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Use the WMS unified search to quickly find orders, products, inventory, locations, purchase orders, and more from one place.
Starshipit WMS includes a **unified search** that lets you find almost anything in the system from a single input — without knowing which section it lives in. You can search across orders, products, inventory, locations, purchase orders, suppliers, packages, process logs, and settings.
## Where to find search
Unified search is the **main dashboard landing page** at [wms.starshipit.com/dashboard](https://wms.starshipit.com/dashboard). When the dashboard is idle (no jobs or notifications requiring immediate attention), the search interface is displayed prominently to encourage quick lookups.
This is a dedicated search page, not a persistent top-bar search box. Navigate to the dashboard to start a search.
## What you can search
A single search query returns results across all of the following:
| Result type | What you can find |
|---|---|
| **Jobs** | Pick jobs, pack jobs, putaway jobs, kitting jobs, and replenishment jobs |
| **Starshipit orders** | Orders synced from your Starshipit account |
| **Products** | SKUs, product names, and barcodes |
| **Inventory** | Stock at specific locations (linked from product results) |
| **Locations** | Warehouse bins, benches, staging docks, and other location types |
| **Containers** | Containers by their identifying reference, including the inventory currently associated with them |
| **Purchase orders** | POs by PO number, supplier, or status |
| **Suppliers** | Supplier records by name |
| **Packages** | Shipping packages associated with completed orders |
| **Process logs** | System events and error entries |
| **Settings** | Settings pages and configuration options |
## How search works
* Enter at least **2 characters**, then press **Enter** to run the search.
* Results are **permission-filtered** — users only see results they have access to based on their role. A warehouse picker will not see settings or admin sections, for example.
* Results are grouped by type, and matching text is highlighted so you can compare related records quickly.
## Typical use cases
**Finding a specific order quickly**
Type the order number or customer reference. The matching order appears in results and you can navigate directly to its detail page.
**Looking up a product by SKU or barcode**
Type the SKU or scan a barcode. WMS shows the matching product record with a link to its inventory position.
**Checking a location**
Type the location name or barcode. WMS shows the matching location and a summary of what is stored there.
**Investigating a process log issue**
Type keywords from an error message or job reference. Matching process log entries appear in results so you can jump directly to the relevant event.
**Finding a setting**
Type a keyword related to what you want to configure (for example, "replenishment" or "receiving"). WMS shows matching settings pages.
## Tips for effective searching
* **Use short, specific terms.** A SKU code or order number returns more focused results than a long phrase.
* **Scan rather than type for barcodes.** Unified search accepts barcode scanner input — scan a product or location barcode to jump straight to the right record.
* **Check process logs when something looks wrong.** If an order or product is behaving unexpectedly, searching in process logs can show you system events leading up to the issue.
---
# Set up WMS Mobile
URL: https://support.starshipit.com/articles/14700000000023-set-up-wms-mobile
Canonical: https://support.starshipit.com/articles/14700000000023-set-up-wms-mobile
Markdown: https://support.starshipit.com/articles/14700000000023-set-up-wms-mobile.md
Updated: 2026-09-04
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Install Starshipit WMS Mobile, pair a device for WMS workers, configure scanning and equipment, and verify your workspace.
Set up **Starshipit WMS Mobile** to complete WMS jobs, receive and move stock, and manage inventory from a handheld device. For standard Starshipit orders, use [Starshipit Pick & Pack](/articles/14427779060367-set-up-the-pick-pack-mobile-app) instead.
:::note
In the standard workflow, finishing a pick job does not automatically open packing. Completing the pick creates the pack job, then returns the user to **Jobs**. Start the pack job separately from **All Jobs**, **My Jobs**, or **More > Pack Now**.
:::
## Installing the app
In WMS, go to **System > Settings**, open the **Apps** tab, and scroll to **Mobile Apps**:
* **iOS** - tap **Download for iOS** to open the App Store listing.
* **Android** - tap the Android download link.
Look for **Starshipit WMS Mobile** in the store listing.
Mobile devices are automatically redirected to a mobile-optimised experience when accessing WMS from a phone or tablet browser.
## Signing in
:::mobile-screenshot
The **Connect to WMS** screen offers two sign-in paths:
* **Sign in as WMS worker** - use this when your administrator has paired the device for a warehouse worker.
* **Sign in with Starshipit** - connect using your Starshipit account and the permissions assigned to it.
:::
## First-time setup
:::mobile-screenshot
When you sign in for the first time, the app walks through a short setup:
1. **Choose scanner mode** - select **Camera scanner** or **Physical scanner** depending on your hardware.
2. **Choose print settings** - turn device printing on only when this device should send returned labels to its operating-system print flow. Turning it off creates labels without printing them from WMS Mobile; it does not route them through the Pick & Pack Print Client workflow.
3. **Choose equipment** - select a trolley, cart, or other equipment location if required for the work you perform. Kitting does not require equipment.
4. Confirm and enter the app.
You can change these options later from **More > Settings**.
:::
## Make non-AirPrint printers available on iOS
WMS Mobile uses the iOS system print flow. Turn on **Print labels from this device** under **More > Settings > Print settings**, then tap **Select printer** to choose an AirPrint printer available to the iPad.
If your label printers do not support AirPrint, a third-party bridge can make printers connected to a Windows PC or Mac available to iPads on the same network. This lets each iPad user select the required shared printer in WMS Mobile.
### Share printers from a Windows PC
[PrintBridge](https://printbridgeair.com/) can share one or more printers installed on a Windows PC.
Before you start, make sure the Windows PC meets PrintBridge's system requirements, can already print to each label printer, and is connected to the same local network as the iPads. Keep the PC powered on and awake so PrintBridge and its shared printers remain available.
1. Download and install PrintBridge on the Windows PC.
2. Open the PrintBridge Admin panel.
3. Select the printers you want to share, then select **Save & Apply**.
4. On the iPad, open **More > Settings > Print settings** in WMS Mobile.
5. Enable **Print labels from this device**, then tap **Select printer**.
6. Select the shared printer required for that device and print a test label.
### Share printers from a Mac
[Printer Bridge](https://www.generouscorp.com/printer-bridge/) can share one or more printers configured on a compatible Mac.
Before you start, make sure the Mac meets Printer Bridge's system requirements, can already print to each label printer, and is connected to the same local network as the iPads. The Mac must remain awake for its shared printers to stay available.
1. Download and install Printer Bridge on the Mac.
2. Open Printer Bridge and enable each printer you want to share.
3. Keep the Mac awake and connected to the local network.
4. On the iPad, open **More > Settings > Print settings** in WMS Mobile.
5. Enable **Print labels from this device**, then tap **Select printer**.
6. Select the shared printer required for that device and print a test label.
:::important
PrintBridge and Printer Bridge are not developed, provided, or supported by Starshipit. Review each vendor's current requirements, security information, pricing, and support options before installing either product.
:::
## Verify mobile printing
Before processing live orders, complete one test pack job:
1. If this device should print, open **More > Settings > Print settings** and enable **Print labels from this device**.
2. On iOS, select the expected AirPrint printer. On other supported devices, confirm the printer is available in the operating-system print flow.
3. Complete the test pack job and confirm the label reaches the expected printer at the correct size.
If device printing is off, confirm that WMS Mobile creates the label without opening the device print flow. Accounts using the dedicated ship process create a separate ship job instead; printing happens when that job is completed.
WMS Mobile uses direct device printing and does not use Pick & Pack's Desktop App/Print Client fallback. See [how Starshipit printing works](/articles/90200000000155-understand-how-starshipit-printing-works) for the differences between printing routes.
## Pair a device for WMS worker sign-in
Pairing lets WMS workers use the mobile app without their own Starshipit accounts. It links one installation of WMS Mobile to one WMS account and signs in the worker selected by the administrator.
### Before you pair
Make sure:
* A WMS administrator has [created an active WMS worker and assigned the correct role](/articles/14700000000036-wms-users-roles-permissions-client-access).
* The administrator has the **Admin** role, or the `staff.manage` permission and access to all clients.
* The mobile device has internet access and permission to use its camera.
* A fresh installation is signed in through **Sign in with Starshipit**. The pairing setting is only available while a Starshipit user is signed in.
The pairing QR code is single-use and expires after two minutes. Generate it only when the mobile device is ready to scan it.
### Generate and scan the pairing code
1. In desktop WMS, go to **System > Roles & Permissions**.
2. If the worker is not listed, select **Add local worker**. Enter their username, display name and password, choose their role and interface policy, then select **Save worker**.
3. On the **Users** tab, find the active WMS-local worker who will use the device. Use the search box if needed. WMS-local workers have a **Local** label below their display name.
4. At the far right of the worker's row, select the ellipsis (**...**) button to open the **Actions** menu, then select **Pair device**.
5. In the **Pair ** dialog, find the expiry time in the text above the one-time QR code. Keep this dialog open while the mobile device scans the code.
6. On the mobile device, go to **More > Settings > WMS worker pairing**.
7. Tap **Open camera scanner** and allow camera access if prompted.
8. Scan the QR code before it expires.
WMS Mobile displays **Device paired**, signs in the selected worker, and opens **Jobs**.
:::important
The QR code signs the selected worker into the device. Do not save or share the code before it is scanned.
:::
### Verify the pairing
1. In WMS Mobile, go to **More > Settings > Connected Account**.
2. Confirm the worker name, username, and WMS account are correct.
3. Sign out when you have finished checking.
4. From **Connect to WMS**, tap **Sign in as WMS worker**. Confirm the paired account and device appear on the worker sign-in screen.
### Switch to another WMS worker
Another active worker from the same WMS account can use the paired device without repeating the initial Starshipit sign-in:
1. Go to **More > Settings > Connected Account**.
2. Tap **Switch WMS worker**, then confirm **Switch Worker**.
3. Enter the next worker's WMS username and password, or tap **Scan WMS worker QR** and scan a new code generated for that worker.
The device stays paired to the same WMS account when workers switch.
### Remove or revoke a pairing
Remove a pairing when the device changes warehouse, changes WMS account, or should no longer allow worker sign-in.
To remove it from the mobile device:
1. Sign out of the WMS worker session.
2. Sign in through **Sign in with Starshipit**.
3. Go to **More > Settings > WMS worker pairing**.
4. Tap **Remove pairing**, then confirm **Remove**.
An administrator can also go to **System > Roles & Permissions**, find the device under **Paired devices**, and select **Revoke**. Removing or revoking the pairing ends its WMS worker sessions. The device must be paired again before another WMS worker can sign in.
### Troubleshoot pairing
| Problem | What to do |
|---|---|
| **WMS worker pairing** is not visible in mobile Settings | Sign out, then use **Sign in with Starshipit**. A WMS worker session cannot manage the device pairing. |
| The QR code is invalid, expired, or already used | Close the code in desktop WMS, generate a new one, and scan it within two minutes. |
| The device is already paired to another WMS account | Remove the existing pairing from the device or revoke it from the original WMS account, then pair it to the new account. |
| **Pair device** is missing for the worker | Confirm the worker is a WMS-local worker and is active. Also confirm the administrator can manage roles and has access to all clients. |
| The camera does not open or scan | Allow camera access in the device settings, confirm the device is online, and increase the brightness of the screen showing the QR code. |
| Worker sign-in is temporarily locked after repeated failures | Wait 15 minutes before trying again, or ask an administrator to check the worker's username, status, access expiry, and password. |
## Main navigation
:::mobile-screenshot
The app has three tabs:
| Tab | What it shows |
|---|---|
| **Jobs** | All available and assigned jobs, with filters for **All Jobs**, **My Jobs**, and job type |
| **Inventory** | Search products and review on-hand, committed, available, incoming, and location quantities |
| **More** | Pack Now, receiving, stock movement and adjustment actions, and Settings |
:::
## How pick and pack flow on mobile
For normal outbound work, mobile follows a two-step job flow:
1. Complete the **pick job**.
2. Return to the jobs list or packing entry point.
3. Open or claim the separately created **pack job**.
This is different from **Pack Now**, which is an expedited flow designed to move an order straight into packing rather than following the standard pick-then-pack sequence.
## Settings reference
| Setting | What it does |
|---|---|
| **Connected Account** | Review the signed-in WMS worker or Starshipit account and the active WMS account |
| **Equipment** | Set your active equipment location, or clear it |
| **Scanner settings** | Switch between camera and physical scanner |
| **Print settings** | Turn direct device printing on or off and configure the device printer where supported. Turning it off does not select a Desktop App or Print Client machine. |
| **Notifications** | Set job assignment notification preferences |
| **WMS worker pairing** | View the paired device, scan a pairing code, or remove the pairing while signed in with Starshipit |
| **Theme Settings** | Use the system, light, or dark theme |
| **Error Logs** | View and manage mobile error logs for troubleshooting |
## Next steps
* [Pick orders with Starshipit WMS Mobile](/articles/14700000000025-mobile-picking) - standard and tote pick jobs on the floor
* [Receiving purchase orders on mobile](/articles/14700000000026-receiving-purchase-orders-on-mobile) - receive stock from a PO without a desk
* [Putaway and replenishment on mobile](/articles/14700000000027-putaway-and-replenishment-on-mobile) - move stock from staging and top up pick faces
* [Kitting on mobile](/articles/14700000000028-kitting-on-mobile) - assemble component products into kits
* [View inventory, scan locations and adjust stock](/articles/14700000000029-view-inventory-scan-locations-and-adjust-stock) - check and correct stock levels on the floor
* [Manage jobs in Starshipit WMS Mobile](/articles/14700000000030-jobs-on-mobile) - claim, manage and track jobs from your device
---
# Manage inventory in WMS Mobile
URL: https://support.starshipit.com/articles/14700000000029-manage-inventory-in-wms-mobile
Canonical: https://support.starshipit.com/articles/14700000000029-manage-inventory-in-wms-mobile
Markdown: https://support.starshipit.com/articles/14700000000029-manage-inventory-in-wms-mobile.md
Updated: 2026-08-14
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> View stock at a location, make inventory adjustments, and run cycle counts on the warehouse floor using the Starshipit WMS mobile app.
The mobile app lets you check and correct stock levels directly on the floor — no need to go back to a desktop to investigate discrepancies or make quick adjustments.
Use **Inventory** to search products and review their stock position. Open **More** for location scanning, stock movement and adjustment actions.
:::mobile-screenshot
When you open a product from **Inventory**, the app shows on-hand, committed, available and incoming quantities, followed by the stock recorded at each location.
:::
## View inventory at a location
Scan a location to see exactly what stock is currently recorded there.
1. Go to **More > Scan Location**.
2. Scan the location barcode (or type the location name).
3. The app shows all products and quantities currently at that location.
From here, you can select any product and jump straight into an adjustment if what you see in the app doesn't match what's physically in the location.
## Adjust inventory
Use **Adjust Inventory** when you need to correct a stock quantity — for example, after finding a discrepancy or reconciling a short pick.
1. Go to **More > Adjust Inventory**.
2. Scan or search for the **product**.
3. Select the **location** to adjust.
4. Enter the **increase or decrease quantity**.
5. Select a **reason** (e.g. damage, count correction) and add a reference if needed.
6. Tap **Submit**.
The adjustment is recorded immediately and appears in the stock movement log with the reason and your user details.
## Cycle counts
A cycle count lets you verify the stock at a location by physically counting what is there and submitting the count. The system compares your count against the expected quantity and records any variance.
WMS Mobile can run an existing cycle count job, but it cannot manually create one. Use **Create Cycle Count** on the WMS web dashboard to create a manual job for one product at one eligible location.
1. Open **Jobs**, then select a cycle count from **All Jobs** or **My Jobs**.
2. Go to the specified location.
3. Scan the location barcode.
4. Count the items and enter the quantity for each product.
5. Submit the count.
If the count matches, no adjustment is made. If there is a variance, the system records it and updates the inventory — or flags it for review depending on your settings.
### Creating cycle count jobs from a pick
If you spot a discrepancy while picking — for example, the bin is empty or has the wrong item — you can use **Report Issue** from the pick step. This creates a cycle count job at that location so it can be properly investigated without blocking your current pick job.
## Next steps
* [Stocktakes and cycle counts (desktop)](/articles/14700000000015-stocktakes-and-cycle-counts) — how to create a one-product-at-one-location cycle count and manage jobs from WMS web.
* [Stock integrity and adjustments (desktop)](/articles/14700000000020-stock-integrity-and-adjustments) — manual adjustments and write-offs.
---
# Pick orders in WMS Mobile
URL: https://support.starshipit.com/articles/14700000000025-pick-orders-in-wms-mobile
Canonical: https://support.starshipit.com/articles/14700000000025-pick-orders-in-wms-mobile
Markdown: https://support.starshipit.com/articles/14700000000025-pick-orders-in-wms-mobile.md
Updated: 2026-08-03
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Pick customer orders on the warehouse floor using the Starshipit WMS mobile app, including standard single-order picking and tote picking for multi-order runs.
Use the mobile app to pick customer orders directly from the warehouse floor — scanning locations and products to confirm picks without returning to a desk.
:::note
Completing a pick does not open packing automatically. Once picks are staged, open or claim the separately created pack job in Starshipit WMS Mobile or continue from the WMS packing dashboard.
:::
## How picking works in the app
A few things apply to all pick jobs:
* **Equipment** — picking jobs require a trolley or cart. Your equipment location is set in **Settings > Equipment**.
* **Scanning or manual entry** — depending on your setup, you can scan barcodes to build quantities, use manual +/− buttons, or both.
* **Partial picks** — if you can't complete the full quantity, you can short-pick a line and continue.
* **Report Issue** — if something is wrong at a location (missing stock, wrong item, damaged goods), use **Report Issue** from the pick step. This creates a follow-up cycle count job so the stock can be investigated.
## Standard picking
Use standard picking when you are working on a pick job for one or more orders.
### How it works
1. Open **Jobs**, then select a pick job from **All Jobs** or **My Jobs**.
2. Go to the first required location.
3. Scan the **source location barcode** to confirm you are in the right spot.
4. Scan the **product barcode** to build the picked quantity, or use manual quantity buttons.
5. Repeat for each location until all items are done.
6. Bring the picked items to a packing bench and scan or select the bench to confirm staging.
The job is complete once all picked items have been staged and the app shows the completion screen.
:::mobile-screenshot
The pick screen shows the order, product image, SKU, quantity, tracking details and expected source location before you confirm where you are.
:::
:::mobile-screenshot
After confirming the location, scan the product to increment the quantity. Depending on your permissions, the same step may also show manual quantity, issue reporting and reallocation controls.
:::
## Tote picking
Use tote picking when the job is set up as a tote pick and each order needs its own tote.
Tote picking lets you pick for multiple orders in one warehouse run, sorting items into totes as you go rather than sorting at the bench afterwards.
### How it works
1. Open the tote pick job in the app.
2. **Assign a tote to each order** — scan each tote barcode and link it to the order it represents.
3. Move through the warehouse by location.
4. At each location, pick the required items and place each into the correct tote.
5. Scan the tote barcode to confirm the item went into the right one.
6. Continue until all items are picked and sorted.
The job is complete when all items are placed and you confirm the tote pick. Orders are then passed to the packing workflow.
## Next steps
* [Validate batches and expiry dates with GS1 barcodes](/articles/14700000000055-validate-batches-and-expiry-dates-with-gs1-barcodes-in-wms-mobile) — confirm that labelled tracked stock matches the selected WMS allocation.
* [Setting up the mobile app](/articles/14700000000023-setting-up-the-mobile-app) — scanner config, equipment, and settings.
* [Picking orders (desktop)](/articles/14700000000011-picking-orders) — desktop picking and batch workflows.
* [Jobs on mobile](/articles/14700000000030-jobs-on-mobile) — claim, filter, and manage jobs from your device.
---
# Receive purchase orders in WMS Mobile
URL: https://support.starshipit.com/articles/14700000000026-receive-purchase-orders-in-wms-mobile
Canonical: https://support.starshipit.com/articles/14700000000026-receive-purchase-orders-in-wms-mobile
Markdown: https://support.starshipit.com/articles/14700000000026-receive-purchase-orders-in-wms-mobile.md
Updated: 2026-07-22
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Receive stock against a purchase order on the warehouse floor using the Starshipit WMS mobile app, including quantity entry, tracking details, and carton counts.
Use the mobile app to receive incoming deliveries directly on the warehouse floor — without needing to go back to a desktop workstation.
## Before you start
Make sure:
* The purchase order (PO) has been created in WMS with the correct supplier and line items.
* Products on the PO have tracking types set if batch, serial, or expiry tracking is required.
See [Suppliers and purchase orders](/articles/14700000000007-suppliers-and-purchase-orders) for how to create POs.
## How to receive a PO on mobile
1. Open the app and go to **More > Receive PO**.
2. Select the purchase order you are receiving against. You can search by PO number or supplier.
3. Select a **line** to receive — scan or search for the product.
4. Select the **receiving location** (typically a staging dock).
5. Enter the **received quantity**.
6. If the product uses batch, serial, or expiry tracking, enter the required tracking details.
7. Enter the **number of cartons** received (if applicable).
8. Tap **Submit** to record the receipt.
Repeat for each line in the PO. The PO status updates automatically as lines are received.
:::mobile-screenshot
Use the status filters or sorting controls to find the correct receivable PO. Each card shows the supplier, item count, ordered quantity, received quantity and remaining quantity.
:::
:::mobile-screenshot
After opening a PO, the item list shows product images, SKUs, barcodes, tracking type and the remaining quantity for each line.
:::
## Partial receipts
If a supplier ships less than expected, you can receive only the quantity that arrived. The PO moves to **Partially Received** and stays open for the remaining quantity.
When you decide not to receive the remainder, mark the outstanding lines as missing or close the PO from the desktop.
## After receiving
Once stock is received, it sits at the staging/receiving location until a putaway job is created to move it to final storage. See [Putaway and replenishment on mobile](/articles/14700000000027-putaway-and-replenishment-on-mobile) for the next step.
## Next steps
* [Putaway and replenishment on mobile](/articles/14700000000027-putaway-and-replenishment-on-mobile) — move received stock to storage locations.
* [Suppliers and purchase orders (desktop)](/articles/14700000000007-suppliers-and-purchase-orders) — create and manage POs.
---
# Troubleshoot Starshipit WMS Mobile
URL: https://support.starshipit.com/articles/14700000000038-troubleshoot-starshipit-wms-mobile
Canonical: https://support.starshipit.com/articles/14700000000038-troubleshoot-starshipit-wms-mobile
Markdown: https://support.starshipit.com/articles/14700000000038-troubleshoot-starshipit-wms-mobile.md
Updated: 2026-09-04
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Fix sign-in, scanning, equipment, jobs, permissions, network, and label issues in Starshipit WMS Mobile.
Use this guide when Starshipit WMS Mobile cannot sign in, scan, load warehouse work, continue a job, or hand a label to the correct printer.
## Before you troubleshoot
Confirm these details first:
* You installed **Starshipit WMS Mobile**. If your team works with standard Starshipit orders instead of WMS jobs, use **Starshipit Pick & Pack**. [Compare the Starshipit mobile apps](/articles/90200000000301-choose-the-right-starshipit-mobile-app).
* The device has a working internet connection.
* **More > Settings > Connected Account** shows the expected worker or Starshipit account and WMS account.
* **More > Settings** shows the app version under **App Information**.
:::important
Starshipit WMS Mobile does not support offline warehouse processing. The app needs a live connection to load, claim, update, pause, resume, and complete work. Local settings or recovery data do not mean a scan or stock movement reached WMS.
:::
## Fix sign-in and pairing issues
### Sign in with Starshipit
1. Tap **Sign in with Starshipit**.
2. Complete sign-in in the browser window that opens.
3. Return to Starshipit WMS Mobile and wait for onboarding or the jobs screen to load.
4. Open **More > Settings > Connected Account** and confirm the account name and account ID.
If the browser does not open or authentication fails, confirm the device is online and can open other websites. If the app reports that the account has no API key or cannot access WMS, ask your Starshipit administrator to check the account rather than entering or sharing credentials with another worker.
### Sign in as a WMS worker
**Sign in as WMS worker** appears on **Connect to WMS** only after the device has been paired to a WMS account. If it is missing, sign in with Starshipit, then follow [Pair a device for WMS worker sign-in](/articles/14700000000023-setting-up-the-mobile-app#pair-a-device-for-wms-worker-sign-in).
On a paired device, tap **Sign in as WMS worker**, then enter the worker's WMS username and password or scan a worker QR code. If sign-in is temporarily locked after repeated failures, wait 15 minutes or ask an administrator to check the worker's username, status, access expiry, and password.
### Replace a signed-in Starshipit account with a code
A print client code can replace the Starshipit account only after you are already signed in through **Sign in with Starshipit**. The initial **Connect to WMS** screen does not offer code sign-in.
1. In WMS on desktop, go to **System > Settings > Apps > Mobile Sign In Code**.
2. Select **Get code**.
3. In Starshipit WMS Mobile, go to **More > Settings > Connected Account**.
4. Tap **Connect by print client code** and enter the code before it expires.
5. Generate a new code if the first code has expired or is rejected.
Entering the code replaces the signed-in Starshipit account and returns the app to that account's default WMS account. An administrator needs access to WMS settings to generate the code. Never include a password, API key, or unexpired code in a support request.
## Fix camera or physical scanner input
Open **Settings > Scanner settings** and confirm the mode matches your hardware.
### Camera scanner does not open or scan
1. Select **Use camera scanner**.
2. Allow camera access in the device's operating-system settings.
3. Return to the scan step and tap the camera button.
4. Test a clear, undamaged barcode that belongs to the active WMS account.
The camera button is hidden when **Use physical scanner** is selected. Devices without a camera must use a physical scanner.
### Physical scanner types but does not submit
1. Pair the scanner with the device by Bluetooth or USB.
2. Select **Use physical scanner** in **Scanner settings**.
3. Enable **Auto-focus scanner input** so the current scan field keeps focus.
4. Configure the scanner to send an **Enter** or **Return** suffix after each barcode.
5. Enable **Show on-screen keyboard** only if you also need manual entry.
If characters appear in the field but the app does not continue, check the scanner's Enter or Return suffix first. If characters appear in the wrong field, tap the expected scan field or enable auto-focus.
WMS administrators can control barcode scanning and typed barcode entry from **Settings > Job Interface**. The on-screen keyboard setting cannot override an account policy that requires scanner input.
If the scanner submits a value but WMS rejects it, confirm the barcode is assigned to the expected product, location, tote, or job. A rejected mapped value is a WMS data issue rather than a scanner connection issue.
## Restore equipment and location state
### Restore device equipment
Picking, tote picking, advisory putaway, and replenishment can require an equipment location such as a trolley or cart.
1. Open **Settings > Equipment**.
2. Select the equipment you are physically using.
3. Return to the job and confirm the selected equipment shown in the job matches.
The app saves the selected equipment on the device. Check it again after changing accounts, changing equipment, or starting a new shift.
If no equipment appears, ask an administrator to confirm the location exists in WMS and has the **Equipment** location type. See [Locations and warehouse setup](/articles/14700000000033-starshipit-wms-locations-and-warehouse-setup).
If a pick job says it is locked to different equipment, continue with the equipment named in the message. Do not repeatedly switch equipment. If that equipment is unavailable, ask a supervisor to inspect the job in WMS before changing its state. For tote picking, also confirm the totes belong to the selected equipment.
### Select equipment for enforced putaway
Enforced putaway does not use the equipment selected in **Settings > Equipment**. Open the job and select from the compatible equipment shown in the putaway flow. WMS locks that equipment to the job after gathering starts.
If no compatible equipment appears, ask an administrator to confirm that an **Equipment** location exists. For client-owned stock, the equipment must be empty, already contain stock for the same client, or allow mixed-client stock.
If the job is already locked to equipment, continue with the equipment shown in the job. If it is unavailable, ask a supervisor to inspect the job in WMS before changing its state.
### Fix location scans
If a location scan fails, check that:
* The location belongs to the active account.
* Its barcode is configured in WMS.
* You scanned the source, destination, staging, or packing location requested on screen.
* The physical barcode exactly matches the configured value.
## Find missing or stuck jobs
1. Clear the job search and set the job-type filter to **All**.
2. Check both **My Jobs** and **All Jobs**.
3. Pull down on the list to refresh it.
4. Confirm **More > Settings > Connected Account** shows the expected worker, Starshipit account, and WMS account.
5. Ask a supervisor to check the job's type, status, assignment, and order in desktop WMS.
**My Jobs** shows work assigned to you. **All Jobs** shows unassigned work you can claim and work already assigned to you. Job types you do not have permission to perform are not included.
Some job states need a specific recovery:
* A pack job showing **Waiting for picks** cannot start until all related pick work is staged. Complete the remaining pick work, then refresh the pack job.
* A paused pack or ship job must be resumed in WMS before mobile processing can continue.
* A multi-order pack or ship job is not supported by the mobile single-order flow. Complete it from the desktop packing or shipping workflow.
* A job assigned to another worker will not appear in **My Jobs**. A supervisor can check or change the assignment in WMS.
If the app was closed during a job, reopen **My Jobs** and open the same job. Use the status and quantities returned by WMS as the source of truth.
## Check permissions
Mobile job types and actions follow the worker's WMS role and permissions. A missing action, an absent job type, or an **Insufficient permissions** error can mean the worker does not have access to that operation.
Ask a WMS administrator to check **System > Roles & Permissions** and confirm the worker can access the required job type or inventory action. The server checks permissions again when the app submits an action, even if a button was visible before the latest permission update.
After permissions change, bring the app back to the foreground and pull down to refresh the job list. Sign out and back in if the old access still appears.
## Recover after a network interruption
1. Stop scanning or submitting actions when a connection error appears.
2. Record the last success message shown by the app.
3. Restore Wi-Fi or mobile data and confirm another website loads.
4. Reopen the affected job from **My Jobs**.
5. Pull down to refresh or tap **Retry** or **Refresh** on the error screen.
6. Compare the job status and quantities with desktop WMS before repeating an action whose result is unclear.
Do not assume a scan was accepted just because its value appeared on screen. WMS only records work after the relevant request reaches the server successfully. Do not clear app data or reinstall the app before exporting error logs, because this can remove local troubleshooting and recovery information.
## Resolve label and printing handoff issues
First identify which printing workflow the account uses.
### The account uses the dedicated ship process
Device label printing is unavailable by design. Complete packing on mobile, then open the shipping queue in desktop WMS to create and print the label.
If the packed order does not reach the shipping queue, record the pack job ID and order number and ask a supervisor to check the job and order status in WMS.
### The mobile device prints the label
1. Open **Settings > Print settings**.
2. Enable **Print labels from this device**.
3. On iOS, tap **Select printer** and confirm the expected printer is shown.
4. On other supported devices, confirm the required printer or print service is available in the operating system's print flow.
5. Confirm the device and network can reach the printer.
6. Retry only after checking whether WMS or Starshipit already created the shipment and tracking number.
If your iPad cannot discover printers connected to a Windows PC or Mac, see [Make non-AirPrint printers available on iOS](/articles/14700000000023-setting-up-the-mobile-app#make-non-airprint-printers-available-on-ios) for optional third-party AirPrint bridges.
When device printing is enabled, WMS Mobile requests the label and then sends the returned PDF to the device's system print flow. It does not use the Pick & Pack mobile app's Print Client workflow.
If a shipment and tracking number already exist but the local print step failed, reprint the existing label from desktop WMS. Do not create another shipment just to print the same label. If no shipment exists, correct the carrier, address, packaging, or connection error shown in the app, then retry.
For more about the packing and desktop shipping handoff, see [Packing and shipping orders](/articles/14700000000012-packing-and-shipping-orders).
## Export or delete support logs
Export logs before deleting them:
1. Open **Settings > Error Logs**.
2. Tap an error to review its timestamp, message, and details.
3. Tap **Export Logs** and share the export with Starshipit Support using the device's share menu.
To remove one log, open it and tap **Delete This Log**. To remove all logs, tap **Clear All Logs**. Deletion is permanent on that device, so only delete logs after support confirms they are no longer needed.
Error logs record app errors, but they may not contain every unsuccessful workflow. Include the evidence below even when the log list is empty.
## Collect evidence for support
Include all relevant details in one support request:
* Worker or Starshipit account and WMS account from **More > Settings > Connected Account**.
* App version from **App Information** under **More > Settings**.
* Device make and model, operating-system version, and whether the app is on iOS or Android.
* Date and exact local time of the problem, including time zone.
* Worker name, job ID, job type, job status, order number, and affected product SKU where relevant.
* Selected equipment name and the expected source, destination, staging, or packing location.
* Scanner mode, scanner make and model, connection type, and whether scanned characters appeared in the field.
* The exact error message and a screenshot showing the full screen.
* The last successful step and the actions that reproduce the problem.
* Network type and whether the problem continues on another reliable network.
* For printing, the printing workflow, printer make and model, selected printer or print service, and whether a shipment or tracking number was created.
* The exported error logs from **Settings > Error Logs**.
Do not include passwords, API keys, or active mobile sign-in codes. [Contact Starshipit Support](/articles/13017036853647-how-do-i-get-in-touch-with-starshipit-support) after collecting the evidence.
## Confirm the recovery
After applying a fix:
1. Refresh the relevant list or reopen the job.
2. Complete one normal scan or action.
3. Confirm the expected job, inventory, or shipment state in WMS.
4. Confirm the app no longer shows the original error.
## Related articles
* [Set up Starshipit WMS Mobile](/articles/14700000000023-setting-up-the-mobile-app)
* [Jobs on mobile](/articles/14700000000030-jobs-on-mobile)
* [Mobile picking](/articles/14700000000025-mobile-picking)
* [WMS settings reference](/articles/14700000000031-wms-settings-reference)
---
# Manage jobs in WMS Mobile
URL: https://support.starshipit.com/articles/14700000000030-manage-jobs-in-wms-mobile
Canonical: https://support.starshipit.com/articles/14700000000030-manage-jobs-in-wms-mobile
Markdown: https://support.starshipit.com/articles/14700000000030-manage-jobs-in-wms-mobile.md
Updated: 2026-08-14
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Understand how jobs work in the Starshipit WMS mobile app - claim jobs, manage assignments, filter by type, and know which workflows can be initiated from mobile.
:::mobile-screenshot
The **Jobs** tab gives you a real-time view of warehouse work. Use the filter to switch between **All Jobs** and **My Jobs**, or narrow the list by job type.
:::
## All Jobs and My Jobs
:::mobile-screenshot
**All Jobs** shows work you can access, including unassigned jobs you can claim and jobs already assigned to you. **My Jobs** narrows the list to your assigned work and is the best view to use at the start of a shift.
Open the filter to switch job lists and select a job type such as picking, packing, shipping, putaway, replenishment, kitting, or cycle count.
:::
:::mobile-screenshot
From **Jobs** you can:
* **Search and filter** by job type (picking, packing, shipping, putaway, replenishment, kitting, cycle count)
* **Claim** an unassigned job and start it immediately
* **Release** a job back to the unassigned queue if you can't complete it
* **Scan to find** a specific job using its barcode or ID (in scanner mode)
Picking jobs can offer **Claim**, **Claim & Tote Pick**, and **Claim & Standard Pick**. Choose the mode that matches how you will organise the run.
:::
## Job types in the mobile app
| Job type | What it involves |
|---|---|
| **Picking** | Collect items for customer orders and stage to a packing bench |
| **Tote picking** | Pick for multiple orders at once into separate totes |
| **Packing** | Verify items, confirm the pack, and print the label for a ready pack job |
| **Shipping** | Confirm packaging, the carrier, and the label for a ready shipping job |
| **Putaway** | Move received stock from staging to storage |
| **Replenishment** | Top up pick faces from bulk storage |
| **Kitting** | Collect components and assemble into a kit SKU |
| **Cycle count** | Verify and correct stock quantities at a location |
## How pack jobs appear
Most outbound mobile work starts on desktop and is then executed on mobile:
1. A desktop user releases the order or creates the batch.
2. WMS creates the **pick job**.
3. After the pick is completed, WMS creates the **pack job**.
4. The mobile user then opens or claims that pack job separately.
In the standard flow, completing a pick does **not** automatically move the user straight into packing. The app returns them to the jobs list, where they start the pack job as its own step.
:::important
WMS Mobile displays pack jobs for a single order only. Pack jobs that contain multiple orders are not shown in the mobile app. Complete those pack jobs in the WMS web app or on the Desktop Packing page instead.
:::
## Jobs you can create on mobile
Most jobs are created from the desktop and then appear in the mobile app for execution. However, a few can also be initiated directly from mobile:
* **Cycle count jobs** - WMS creates a follow-up job automatically when you use **Report Issue** during a pick. WMS Mobile does not provide the manual **Create Cycle Count** action. Create a manual one-product-at-one-location job from the WMS web dashboard. See [View inventory, scan locations and adjust stock](/articles/14700000000029-view-inventory-scan-locations-and-adjust-stock).
* **Receive PO** - not a job in the traditional sense, but you can initiate and complete a receipt entirely from **More > Receive PO** without a pre-assigned job.
* **Inventory adjustments** - submitted directly from **More > Adjust Inventory** without a job being created first.
## FAQ
Can I see jobs assigned to other people?
**All Jobs** shows unassigned jobs you can claim and jobs assigned to you. It does not show jobs assigned to other workers. If you need to reassign jobs across workers, do that from WMS web.
Can I assign pack jobs to other people from the mobile app?
The normal mobile workflow is to open or claim already-created pack jobs. Job assignment and reassignment are handled from the desktop when needed.
What happens if I close the app mid-job?
Progress is saved as each step is submitted. If you reopen the app, your in-progress job will be in My Jobs. In most job types you can pick up where you left off.
---
# Build kits in WMS Mobile
URL: https://support.starshipit.com/articles/14700000000028-build-kits-in-wms-mobile
Canonical: https://support.starshipit.com/articles/14700000000028-build-kits-in-wms-mobile
Markdown: https://support.starshipit.com/articles/14700000000028-build-kits-in-wms-mobile.md
Updated: 2026-08-17
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Assemble component products into kits or bundles on the warehouse floor using the Starshipit WMS mobile app.
Use the mobile app to complete kitting jobs — collecting component products and assembling them into a finished kit or bundle SKU.
Kitting does not require equipment (no trolley or cart needed).
## When kitting is used
Kitting applies when you use **require stock** bundles — bundle SKUs that need to be physically assembled before they can be allocated and shipped. Stock for the finished kit is built from its component SKUs.
## How it works
1. Open **Jobs**, then select a kitting job from **All Jobs** or **My Jobs**.
2. Review the component list — the job shows each component SKU, its required quantity, and source location.
3. Go to the first component location.
4. Scan the **source location** to confirm placement, then scan or confirm the **product** and quantity.
5. Repeat for each component until all are collected.
6. Select the **Kit Assembly Location** where the finished kits will be assembled.
7. Select **Complete Kitting** when the assembly location is **Bulk Storage** or **Pick Face**. The kits remain at that location.
8. Choose how the kits should leave a temporary assembly location:
* Select **Place in storage**, then choose a **Bulk Storage** or **Pick Face** location to move the kits there immediately.
* Select **Create putaway job** when that assembly location supports putaway. The kits remain reserved at the assembly location until the putaway job is completed.
9. Select **Continue to Placement** to complete the job and apply the selected follow-up action.
The component quantities are reduced and the kit SKU inventory is increased at its final location. When you create a putaway job, the completed kits stay at the assembly location until that job moves them to storage.
## Expedited kitting
If you need to assemble kits urgently from the desktop, use **Expedited Kitting** to create and execute a kitting job in one step. See [Expedited fulfilment](/articles/14700000000013-expedited-fulfilment-pack-now-batch-pack-now) for details.
## Next steps
* [Products and inventory configuration](/articles/14700000000006-starshipit-wms-products-and-inventory-configuration) — how to set up bundle and kit products.
* [Jobs on mobile](/articles/14700000000030-jobs-on-mobile) — manage and claim kitting jobs from your device.
---
# Pack and ship orders in WMS Mobile
URL: https://support.starshipit.com/articles/14700000000037-pack-and-ship-orders-in-wms-mobile
Canonical: https://support.starshipit.com/articles/14700000000037-pack-and-ship-orders-in-wms-mobile
Markdown: https://support.starshipit.com/articles/14700000000037-pack-and-ship-orders-in-wms-mobile.md
Updated: 2026-08-03
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Find and claim single-order pack jobs, verify items, confirm packaging and carriers, and complete labels in Starshipit WMS Mobile.
Use Starshipit WMS Mobile to claim a ready pack job, verify the picked items, confirm packaging and a carrier, and complete the order from a handheld device.
## Before you begin
Make sure:
* You are signed in to the correct WMS workspace. See [Set up Starshipit WMS Mobile](/articles/14700000000023-setting-up-the-mobile-app).
* Your WMS role includes access to packing jobs. You also need permission to claim a job if it is not already assigned to you.
* The order has a single-order pack job. Batch pack jobs must be completed from the WMS web Packing dashboard.
* The order has been picked and staged, or has been sent straight to packing with **Pack Now**.
* Your warehouse has the required packing bench and package templates set up.
:::important
Completing a pick does not open packing automatically. WMS creates the pack job as separate work. Return to **Jobs** to find and start it.
:::
## Find and start the pack job
1. Open **Jobs** in Starshipit WMS Mobile.
2. Open the filters and select **All Jobs** and the **Packing** job type. Select **My Jobs** instead if the job is already assigned to you.
3. Search for the order or job. You can also use the Jobs scanner to find a specific job.
4. Select the ready pack job.
5. Select **Claim & Start** for an unassigned job, or **Start Job** or **Continue** for a job assigned to you.
If you select **Claim** without starting, the job remains available to you under **All Jobs** or **My Jobs**.
A pack job marked **Waiting for picks** is not ready to start. Finish staging all related pick work, then refresh **Jobs**. A paused pack job must be resumed from WMS web before you can continue it on mobile.
:::note
Starshipit WMS Mobile supports single-order packing and shipping jobs. Use WMS web for batch packing or shipping.
:::
## Follow the bench and location context
The pack job controls where you work and where the items are waiting.
| Context | What to do |
|---|---|
| **Packing bench** | Check the bench shown in the pack job header. This is the bench assigned when the pick was staged or the Pack Now job was created. |
| **Source location** | Follow the location shown in the **Location** phase. Depending on the earlier workflow, this may be a packing bench, tote, pick face, or another WMS location. |
| **Picker equipment** | You do not need to select a trolley or cart to work a pack job. Equipment is part of picking; packing follows the locations recorded on the pack job. |
Do not move to another bench unless the WMS job has been updated. The bench and source locations shown in the job are the stock locations WMS expects you to use.
:::mobile-screenshot
For **Pack Now**, the app may direct you to the stock's current warehouse location because the standard pick was skipped.
:::
## Verify and gather the items
The pack screen moves through **Location > Pick > Pack > Carrier > Print**.
1. Go to the source location shown in the **Location** phase.
2. Scan the location barcode. If your account allows manual location confirmation, you can select **Confirm Location Without Scan** instead.
3. Scan the product barcode. If more than one item is waiting at the location, scan or select the item you are gathering first.
4. Build the required quantity by scanning each unit, or use the manual quantity and **Pick All** controls when your interface settings allow them.
5. Select **Confirm Pick** once the full quantity for that item is shown.
6. Repeat for each item and location until the **Pack** phase becomes available.
For batch-, serial-, or expiry-tracked stock, the assigned tracking details appear on the item as read-only information. Gather the exact batch or serial shown. A matching serial scan is used to select the correct serialised line when several lines share the same SKU.
:::important
Mobile packing requires the full quantity before you can continue to packaging. The **Allow Partial Packing** account setting does not add a partial-pack action to this mobile flow. Use the WMS web Packing dashboard when you need to pack and ship only part of an order.
:::
## Confirm packaging and the carrier
1. In the **Pack** phase, add at least one saved package template.
2. Add or remove packages as needed.
3. Select a package to edit its weight in kilograms and dimensions in centimetres.
4. Select **Save and Continue** after making changes, or **Confirm Packaging** when the package details are already correct.
5. In the **Carrier** phase, select the required carrier service, then select **Confirm Carrier**.
Carrier options are quoted for the confirmed packages and shown from the lowest price first. If **Prevent Carrier/Service Changes in Packing** is enabled, the app shows the carrier and service already selected for the order instead of offering other services.
## Complete packing and create the label
Review the package, carrier, items, and destination in the **Print** phase. The final action depends on your account and device settings.
| Setup | Final action | Result |
|---|---|---|
| Standard packing with device printing on | **Print Label** | WMS creates the shipment and sends the returned label to the device print flow. On iOS, the selected AirPrint printer is used when configured. |
| Standard packing with device printing off | **Create Label** | WMS creates the shipment and label without sending it to a printer on this device. |
| Dedicated ship process | **Complete Packing** | WMS records the packed order and creates a separate shipping job. The label is not created as part of the pack action. |
When the dedicated ship process is enabled, claim the new shipping job separately from **Jobs**, or complete it from the WMS web Shipping dashboard. A mobile shipping job skips item gathering and starts with the package, carrier, and label phases.
After a successful label or packing handoff, the app returns to **Jobs**. If label creation or printing fails, the job stays on the final phase so you can correct the issue and try again.
## Leave or pause an unfinished pack job
Use the back control in the pack screen when you need to stop before completion. The app asks how to leave the job:
* **Stay** keeps the pack screen open.
* **Leave Pack** saves confirmed gather progress, keeps the job **In Progress**, and returns to **Jobs**.
* **Pause Job** saves progress and asks you to choose an account-configured pause reason. Managers can then see why the work is blocked.
A pack job left **In Progress** remains available to continue. Resume a paused pack job from WMS web before reopening it on mobile.
If the pack screen closes unexpectedly, the app saves confirmed gather progress where possible and attempts to return the incomplete job to **Ready**. Find the job again under **Jobs** and check its status before continuing. Use the in-app back control whenever possible so you can choose the intended state.
## Check permissions and settings
WMS administrators manage account-wide permissions and workflow settings from WMS web. Device printing and scanner mode are managed in Starshipit WMS Mobile.
| Permission or setting | Effect on mobile packing |
|---|---|
| Packing access | Shows pack and ship jobs the worker is allowed to process. |
| Claim jobs | Allows a worker to claim an unassigned pack or ship job. |
| Release jobs | Allows a worker to unclaim an assigned job before it starts. |
| **Barcode Scanning** | Shows barcode and camera controls during location and item verification. |
| **Allow Manual Location Confirmation** | Shows **Confirm Location Without Scan** where supported. |
| **Allow Manual Item Selection** | Allows item cards to be selected without scanning. |
| **Allow Manual Quantity Entry** | Shows direct quantity and +/− controls. |
| **Allow Pick All / Receive All Shortcuts** | Shows the one-tap full-quantity control. |
| **Prevent Carrier/Service Changes in Packing** | Locks the carrier and service already selected for the order. |
| **Dedicated Ship Process** | Changes the final pack action to **Complete Packing** and hands the order to a separate shipping job. |
| **Print settings** in the mobile app | Controls whether standard pack labels are printed from this device or only created. |
See the [WMS settings reference](/articles/14700000000031-wms-settings-reference) for account settings, or ask a WMS administrator to review **System > Roles & Permissions** if an action is missing.
## Related articles
* [Validate batches and expiry dates with GS1 barcodes](/articles/14700000000055-validate-batches-and-expiry-dates-with-gs1-barcodes-in-wms-mobile)
* [Mobile picking](/articles/14700000000025-mobile-picking)
* [Jobs on mobile](/articles/14700000000030-jobs-on-mobile)
* [Packing and shipping orders](/articles/14700000000012-packing-and-shipping-orders)
* [Expedited fulfilment with Pack Now](/articles/14700000000013-expedited-fulfilment-pack-now-batch-pack-now)
---
# Put away and replenish stock in WMS Mobile
URL: https://support.starshipit.com/articles/14700000000027-put-away-and-replenish-stock-in-wms-mobile
Canonical: https://support.starshipit.com/articles/14700000000027-put-away-and-replenish-stock-in-wms-mobile
Markdown: https://support.starshipit.com/articles/14700000000027-put-away-and-replenish-stock-in-wms-mobile.md
Updated: 2026-08-06
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Complete advisory or routed putaway jobs and replenish pick faces with the Starshipit WMS mobile app.
Both putaway and replenishment are movement jobs — you pick stock from one location and confirm where it's going next. The exact steps depend on the job type and the putaway destination mode.
Both job types use equipment such as a trolley or cart. Advisory putaway and replenishment use the active equipment selected in **Settings > Equipment**. For enforced putaway, you select compatible equipment when you start the job, and WMS locks it to that job.
## Putaway
**What it is:** Moving received stock from a staging or receiving location to its final storage location.
Putaway jobs are created after stock is received against a purchase order.
### Check which putaway flow applies
The job's destination mode determines the steps you follow:
| Mode | How destinations work |
| --- | --- |
| **Advisory** | WMS suggests destinations. You select each staged item and choose any valid destination. |
| **Enforced** | WMS assigns destinations and guides you through a gather phase followed by an ordered placement route. |
The mode is set when the putaway job is created. Changing **Enforce Putaway Locations** in the browser WMS does not change existing jobs.
### Complete an advisory putaway job
1. Open **Jobs**, then select a putaway job from **All Jobs** or **My Jobs**.
2. Go to the staging location shown in the job.
3. Scan the **source location** to confirm you are in the right spot.
4. Scan or confirm the **product** and quantity to pick up.
5. Move to the **destination location**.
6. Scan the **destination location** to confirm placement.
7. Submit the putaway line.
Repeat for each line in the job. When all lines are done, the job completes.
### Complete an enforced putaway route
1. Open **Jobs**, then select the putaway job from **All Jobs** or **My Jobs**.
2. Select the compatible equipment you will use to collect the stock.
3. Follow the planned lines and scan or confirm each item to gather it from staging onto the equipment.
4. Move to the destination shown for the first placement group.
5. Scan or confirm the assigned destination.
6. Place the directed stock, then confirm the placement.
7. Follow the remaining destinations in the order shown until the job is complete.
When several lines use the same destination, WMS keeps that destination verified while you place those lines. You must verify the location again when the route moves to a different destination.
Select **New location** if an assigned destination cannot be used. WMS replans that line and refreshes the remaining route.
:::important
Enforced putaway only accepts the destination assigned by WMS. Do not move the stock to a different location without selecting **New location** first.
:::
## Replenishment
**What it is:** Moving stock from a bulk storage location to a pick face to keep the forward-picking area stocked.
Replenishment jobs are triggered automatically when a pick face falls below its minimum threshold, or they can be created manually from the desktop.
1. Open **Jobs**, then select a replenishment job from **All Jobs** or **My Jobs**.
2. Go to the **bulk storage location** shown in the job.
3. Scan the source location and product.
4. Pick the required quantity.
5. Move to the **pick face location**.
6. Scan the pick face location to confirm you are putting stock in the right place.
7. Submit.
The pick face inventory is updated once the job is completed.
:::mobile-screenshot
Before moving stock, verify the equipment, product, tracking details and bulk source shown in the job. Select **I Am At The Source** only after you reach the displayed location.
:::
## Next steps
* [Receiving purchase orders on mobile](/articles/14700000000026-receiving-purchase-orders-on-mobile) — the step before putaway.
* [Put away received stock](/articles/14700000000009-putaway) — configure destination modes and verify completed putaway.
* [Replenishment (desktop)](/articles/14700000000016-replenishment) — how replenishment rules and thresholds are configured.
---
# Validate batches and expiry dates with GS1 barcodes in WMS Mobile
URL: https://support.starshipit.com/articles/14700000000055-validate-batches-and-expiry-dates-with-gs1-barcodes-in-wms-mobile
Canonical: https://support.starshipit.com/articles/14700000000055-validate-batches-and-expiry-dates-with-gs1-barcodes-in-wms-mobile
Markdown: https://support.starshipit.com/articles/14700000000055-validate-batches-and-expiry-dates-with-gs1-barcodes-in-wms-mobile.md
Updated: 2026-08-03
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Use GS1 barcodes to confirm products and validate batch, serial and expiry details against allocated stock in WMS Mobile.
Use GS1 barcodes in WMS Mobile to confirm the product and check tracking details against the stock allocated for picking or packing.
## Before you begin
Make sure:
* The WMS product uses the required **Batch** or **Serial** tracking type. See [Configure WMS products and inventory](/articles/14700000000006-configure-wms-products-and-inventory).
* The GS1 Global Trade Item Number (GTIN) in application identifier (AI) `01` is saved as the product's **Barcode** in WMS.
* Batch-tracked stock has been received with the correct batch or lot number and, when required, an expiry date.
* Serial-tracked stock has been received with its individual serial numbers.
* The order has been released so WMS has allocated the required stock, including its batch, serial or expiry details.
* Barcode scanning is available in the worker's WMS interface policy and WMS Mobile is set to the correct camera or physical scanner mode.
* Your scanner sends the complete GS1 payload. For raw element strings, it must preserve the FNC1 group separator between a variable-length value, such as AI `10`, and the next AI. A physical scanner should also send Enter to submit the value.
Test the scanner with a known label before using it for live orders. The WMS parser also recognises parenthesised AIs, such as `(01)09312345678907(10)LOT123(17)260430`.
## Understand what WMS Mobile validates
WMS Mobile processes a GS1 product scan in this order:
1. It uses the product identifier, normally the GTIN in AI `01`, to resolve the WMS product.
2. It reads any supported tracking values from the full scan.
3. It compares batch, expiry or serial values supplied by the scan with the selected WMS allocation.
4. It accepts the scan when the product and supplied tracking values match. It rejects a supplied value that conflicts with the allocation.
Batch and expiry comparisons are case-insensitive and expiry is compared by calendar date.
:::important
If the GS1 scan omits the batch or expiry, that omission alone does not reject the product. WMS Mobile only rejects these details when the scan supplies a value that does not match the selected allocation.
:::
Both AI `15` (best-before date) and AI `17` (expiration date) are treated as the WMS allocation expiry. If a barcode contains both, AI `17` takes precedence.
When AI `21` is present, WMS Mobile uses it for exact serial matching. A supplied serial that does not match an allocated serial is rejected instead of falling back to another unit with the same SKU. If AI `21` is omitted, the existing WMS product and serial scan rules continue to apply.
## Use GS1 scans in each workflow
| WMS Mobile workflow | How GS1 validation applies |
| --- | --- |
| **Standard picking** | Scan the GS1 product barcode at the product confirmation step. WMS compares any supplied batch or expiry with the selected allocation before increasing the picked quantity. |
| **Tote picking** | Scan the GS1 product barcode for the selected source allocation. WMS validates supplied tracking details before accepting the item; tote assignment and tote confirmation remain separate scans. |
| **Packing** | In a single-order mobile pack job, scan the GS1 product barcode while selecting or gathering an allocated item. WMS applies the same product, batch, expiry and serial checks before increasing the gathered quantity. |
This validation confirms that the labelled stock matches the WMS allocation. It does not change the allocation or replace receiving the tracking details into WMS.
## Check supported GS1 application identifiers
The WMS GS1 parser recognises these application identifiers. Only the values described as validation inputs affect the selected pick or pack allocation.
| AI | Value | WMS Mobile behaviour |
| --- | --- | --- |
| `00` | Serial Shipping Container Code (SSCC) | Recognised as an identifier. It does not validate batch, expiry or serial tracking. |
| `01` | GTIN | Resolves the WMS product through its barcode mapping. |
| `10` | Batch or lot number | Compared with the allocation batch when both values are present. |
| `11` | Production date | Recognised by the parser but not compared with the allocation. |
| `15` | Best-before date | Used as the WMS allocation expiry when AI `17` is absent. |
| `17` | Expiration date | Used as the WMS allocation expiry and takes precedence over AI `15`. |
| `21` | Serial number | Used for exact serial matching when present. |
| `30` | Variable count | Recognised by the parser but does not set the picked or packed quantity. Each accepted scan follows the normal WMS Mobile quantity rules. |
## Verify the validation
Use a controlled test order with a batch-tracked line quantity of at least two so the first accepted scan does not complete the line.
1. Release the order and check the batch and expiry allocated in WMS.
2. Open the standard pick, tote pick or single-order pack job in WMS Mobile.
3. Scan a GS1 label whose GTIN and supplied tracking values match the allocation. For tote picking, scan the assigned tote to confirm placement. Confirm the app accepts the item and updates the quantity.
4. Scan a label for the same product with a different batch or expiry. Confirm WMS Mobile shows **Scan Rejected** and does not update the quantity.
5. Scan a valid product label that omits batch or expiry. For tote picking, scan the assigned tote again. Confirm the omission alone does not reject the scan and the quantity updates.
Repeat the check in each mobile workflow your warehouse uses before rolling the labels out broadly.
## Troubleshoot GS1 scans
| Problem | What to check |
| --- | --- |
| WMS Mobile reports the wrong product or cannot find it | Confirm the complete AI `01` GTIN is saved in the WMS product's **Barcode** field. Check that the scanner sends the full value without changing digits. |
| A matching physical label is rejected for batch or expiry | Compare the label with the batch and expiry on the selected allocation. Use the allocated stock or correct the WMS stock and allocation before continuing. |
| Tracking values are ignored or combined into one value | Check the scanner output. Preserve the FNC1 group separator after variable-length AIs such as AI `10` when another AI follows. |
| The wrong serial is rejected even though the GTIN matches | AI `21` identifies an individual serialised unit. Use the serial shown on the selected allocation. |
| GS1 validation works in picking but not in the pack job you opened | WMS Mobile supports single-order pack jobs. Complete batch packing in WMS web. |
## Related articles
* [Pick orders in WMS Mobile](/articles/14700000000025-mobile-picking)
* [Pack and ship orders in WMS Mobile](/articles/14700000000037-pack-and-ship-orders-in-wms-mobile)
* [Configure WMS products and inventory](/articles/14700000000006-configure-wms-products-and-inventory)
---
# Developer Center overview
URL: https://support.starshipit.com/articles/14700000001001-developer-center-overview
Canonical: https://support.starshipit.com/articles/14700000001001-developer-center-overview
Markdown: https://support.starshipit.com/articles/14700000001001-developer-center-overview.md
Updated: 2026-06-18
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Understand Starshipit's API options, account setup, and the integration workflows they support.
Use the Developer Center to choose the right Starshipit API, understand the shared setup steps, and find the workflow or reference page you need before you start building.
## Understand the API options
Starshipit has two API areas. Most shipping integrations use the Starshipit API. If your account uses the Starshipit WMS add-on and you are building warehouse-specific flows, use the WMS API.
| API | Domain | What it is for | Use it when |
| --- | --- | --- | --- |
| Starshipit API | `https://api.starshipit.com` | Shipping and fulfilment workflows in Starshipit. | You need to import orders, update orders, generate labels, get rates, manifest shipments, use webhooks, or receive tracking updates. |
| Starshipit WMS API | `https://wms.starshipit.com` | Warehouse workflows for accounts using the Starshipit WMS add-on. | You need to work with WMS jobs, products, inventory, locations, purchase orders, picking, packing, putaway, replenishment, stocktake, or stock movement workflows. |
Keep shipping and WMS work separate when you design the integration. The account setup is shared, but the endpoint domains and request shapes are different.
## How Starshipit fits into an integration
Starshipit is the shipping system that connects your orders to courier services, labels, manifests, tracking, notifications, rates, rules, sender addresses, and packages.
An integration usually connects another system to Starshipit. That system might be an ecommerce platform, ERP, WMS, middleware tool, marketplace, 3PL system, checkout, or custom app.
## Set up the right Starshipit product first
Both API families use the configuration in the account your key belongs to. Before testing an integration, confirm the account has the setup your workflow depends on.
For Starshipit API shipping workflows, start with [How to set up Starshipit](/articles/getting-started/intro-to-starshipit/how-to-set-up-starshipit), then confirm:
- Sender addresses.
- Couriers and courier services.
- Package settings.
- Shipping rules.
- Checkout rates settings, if you are using the checkout rates endpoint.
- Plain Label courier setup, if you want a mock carrier-style workflow for label testing.
For Starshipit WMS workflows, confirm the account has the WMS add-on enabled and has the warehouse setup your flow depends on, such as products, locations, inventory, jobs, users, purchase orders, picking, packing, or stock movement processes.
If setup is incomplete, the request can authenticate successfully but still return no records, fail validation, or produce an unexpected workflow result.
## Choose your workflow
Most Starshipit API integrations start with one of these jobs:
- Import orders, print labels in the Starshipit UI, then update the source system with tracking.
- Import or update orders, print labels outside the Starshipit UI, then return tracking details.
- Retrieve checkout rates or delivery service options from Starshipit.
- Let Starshipit import orders, then print labels externally by API.
- Update orders before printing labels.
Product Catalogue endpoints and webhooks can support these workflows when you need product enrichment or status updates, but most integrations should start with the order, label, rates, and tracking flow they are trying to solve.
## Start here
1. Read [Authentication and access](/articles/developer-center/getting-started/authentication-and-access) to confirm which credentials and headers you need.
2. Run [Quickstart: Import a test order](/articles/developer-center/getting-started/quickstart-import-a-test-order) to confirm your first safe write request.
3. Read [Testing guidance](/articles/developer-center/getting-started/testing-guidance) before you move beyond test data.
4. Read [Starshipit API fundamentals](/articles/developer-center/starshipit-api/api-fundamentals) or [WMS API fundamentals](/articles/developer-center/starshipit-wms-api/wms-api-fundamentals) before you design retries, pagination, and error handling.
5. Choose the API section closest to the job you are building.
6. Use the [Starshipit API reference guide](/articles/developer-center/starshipit-api/starshipit-api-reference-guide) or [WMS API reference guide](/articles/developer-center/starshipit-wms-api/wms-api-reference-guide) to confirm endpoint details.
## What this center includes
- Practical guides for common Starshipit API workflows.
- WMS API fundamentals and reference entry points for warehouse workflows.
- Quickstarts for order import, label printing, and checkout rates.
- Shared setup guidance for credentials and request structure.
- Testing, rate limit, error, retry, webhook, and compatibility guidance.
- Troubleshooting steps for common request, rate limit, and payload issues.
---
# Authentication and access
URL: https://support.starshipit.com/articles/14700000001002-authentication-and-access
Canonical: https://support.starshipit.com/articles/14700000001002-authentication-and-access
Markdown: https://support.starshipit.com/articles/14700000001002-authentication-and-access.md
Updated: 2026-06-18
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Understand Starshipit API credentials, request headers, domains, and rate limits.
Starshipit has separate API domains for shipping workflows and WMS warehouse workflows. The API key from **Settings > API** is used for both the Starshipit API and the Starshipit WMS API, but the required headers differ by API.
## Before you begin
- Access to **Settings > API** in Starshipit for the API key and subscription key.
- Access to the Starshipit WMS account you are integrating with, if you are calling WMS endpoints.
- A safe place to store secrets in your app or integration platform.
- The Starshipit account you want your integration to access.
For account setup requirements, start with [Developer Center overview](/articles/developer-center/getting-started/developer-center-overview).
## Choose the API domain
| API | Base URL | Use it for |
| --- | --- | --- |
| Starshipit API | `https://api.starshipit.com` | Orders, labels, rates, manifests, tracking, and webhooks. |
| Starshipit WMS API | `https://wms.starshipit.com` | WMS jobs, products, inventory, locations, purchase orders, picking, packing, putaway, replenishment, stocktake, and stock movements. |
Do not send WMS requests to `https://api.starshipit.com`. Do not send core Starshipit shipping API requests to `https://wms.starshipit.com`.
## Understand Starshipit API keys
| Credential | What it controls | Header |
| --- | --- | --- |
| API key | The API key controls which Starshipit account your request can access. Use a different API key when you test against a different account. The same key is used for Starshipit API requests and WMS API requests for that account. | `StarShipIT-Api-Key` for the Starshipit API, `starshipit-api-key` for the WMS API |
| Subscription key | The subscription key controls your API access tier and rate limit for Starshipit API access, including requests made against Starshipit WMS. | `Ocp-Apim-Subscription-Key` for the Starshipit API |
Keep both keys secret. Do not put them in browser code, public repositories, screenshots, or shared logs.
## Get Starshipit API credentials
1. Log in to Starshipit.
2. Go to **Settings > API**.
3. Copy the **API key**.
4. Copy the **Subscription key**.
5. Store both values in your integration's secret store.
You can also read [How to find your Starshipit API key](/articles/integrations/the-starshipit-api/how-to-find-your-starshipit-api-key) if you need the legacy API-key guide.
## Add Starshipit API headers
Each request to `https://api.starshipit.com` must include these headers:
| Header | Description |
| --- | --- |
| `Content-Type` | Use `application/json` for JSON requests. |
| `StarShipIT-Api-Key` | Your account API key from **Settings > API**. |
| `Ocp-Apim-Subscription-Key` | Your subscription key from **Settings > API**. |
## Add WMS API headers
Each request to `https://wms.starshipit.com` must include the WMS authentication header:
| Header | Description |
| --- | --- |
| `starshipit-api-key` | Your Starshipit API key from **Settings > API** for the account using WMS. |
WMS endpoint request and response details are documented in the [WMS API reference](/developers/api-reference/wms).
## Check your request setup
- Use the correct base URL for the API family.
- Include the required authentication headers for that API family.
- Use a different API key for each Starshipit account you test against.
- Match the request body to the endpoint you are calling.
- Log the endpoint, response status, and response body when testing.
## Rate limits
Your Starshipit API access tier controls the rate limit applied to Starshipit API and Starshipit WMS API requests. Developer API access allows two requests per second. Production API access requires approval and uses a higher rate limit.
If you exceed your limit, Starshipit returns `429 Too Many Requests`. Build retry handling with backoff instead of immediately repeating the same request.
Batch requests where the endpoint supports it. For example, use `POST /api/orders/import` to create multiple ready-to-ship orders in one request instead of sending one request per order.
## Verify access
Send a small read-only request first, such as a list or get request, before you create or update production data. Confirm the response returns the expected Starshipit account data.
---
# Quickstart: Import a test order
URL: https://support.starshipit.com/articles/14700000001014-quickstart-import-a-test-order
Canonical: https://support.starshipit.com/articles/14700000001014-quickstart-import-a-test-order
Markdown: https://support.starshipit.com/articles/14700000001014-quickstart-import-a-test-order.md
Updated: 2026-06-18
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Create a safe test order through the Starshipit API and confirm it appears in your account.
Use this quickstart to send one safe test order to Starshipit with `POST /api/orders`, then confirm the order appears before you build a full import workflow.
Use the [Orders API reference](/developers/api-reference/starshipit#orders) when you need the full request model.
## Before you begin
- Confirm your API key and subscription key in **Settings > API**.
- Confirm your account has at least one sender address and courier configured.
- Use a test order number that cannot be confused with a real customer order.
- Decide how you will remove or archive the test order after verification.
:::important
Use a non-customer recipient, test phone number, and internal email address. Do not use real customer personal data in early API tests.
:::
## Safe test payload
Start with the smallest realistic order your account can accept. Replace the address values with safe test data that matches a destination your couriers support.
```bash
curl --request POST \
--url https://api.starshipit.com/api/orders \
--header "StarShipIT-Api-Key: YOUR_API_KEY" \
--header "Ocp-Apim-Subscription-Key: YOUR_SUBSCRIPTION_KEY" \
--header "Content-Type: application/json" \
--data '{
"order": {
"order_number": "API-TEST-1001",
"reference": "Developer quickstart test",
"shipping_method": "Standard",
"destination": {
"name": "API Test Recipient",
"phone": "0200000000",
"street": "20 George Street",
"suburb": "Sydney",
"state": "NSW",
"post_code": "2000",
"country": "Australia",
"delivery_instructions": "Test order only"
},
"items": [
{
"description": "Test item",
"quantity": 1,
"weight": 0.5,
"value": 10,
"sku": "API-TEST-SKU"
}
]
}
}'
```
## Send the request
1. Send the request from your API client, terminal, or integration environment.
2. Confirm the response includes `"success": true`.
3. Store the returned `order_id` and your source order number.
4. Keep the full response body in your test logs.
## Verify the order
Open Starshipit and search for `API-TEST-1001`. Confirm:
- The order appears in the unshipped orders list.
- The destination address matches the payload.
- The item, quantity, SKU, and weight are present.
- Starshipit rules apply the carrier or service you expect.
## Common issues
| Issue | What to check |
| --- | --- |
| `401 Unauthorized` | Confirm both API headers are present and copied from the same Starshipit account. |
| `400 Bad Request` | Confirm the request body is valid JSON and required order fields are present. |
| Order not visible | Search by order number, then confirm you sent the request to the right account. |
| Wrong service selected | Check the `shipping_method` value and matching Starshipit rules. |
## Next steps
- [Print a label by API](/articles/developer-center/getting-started/quickstart-print-a-label-by-api)
- [Plan a Starshipit API integration](/articles/developer-center/starshipit-api/plan-a-starshipit-api-integration)
- [Starshipit API fundamentals](/articles/developer-center/starshipit-api/api-fundamentals)
- [Orders API reference](/developers/api-reference/starshipit#orders)
---
# Quickstart: Print a label by API
URL: https://support.starshipit.com/articles/14700000001015-quickstart-print-a-label-by-api
Canonical: https://support.starshipit.com/articles/14700000001015-quickstart-print-a-label-by-api
Markdown: https://support.starshipit.com/articles/14700000001015-quickstart-print-a-label-by-api.md
Updated: 2026-06-18
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Generate a label through the API and confirm the label response.
Use this quickstart to call `POST /api/orders/shipment` for an order and confirm Starshipit returns tracking and label data.
Use the [Print Label endpoint reference](/developers/api-reference/starshipit#endpoint-shipments-post-api-orders-shipment-print-label) when you need the full request and response model.
## Before you begin
- Create or identify a test order in Starshipit.
- Confirm the order has a valid destination address and package data.
- Confirm the order has a carrier. An order can get a carrier from Starshipit rules, the account's default courier setting, or the `carrier` and `carrier_service_code` values you send in the request.
- Decide where your integration will store the returned label and tracking number.
- Set up [Plain Label](/articles/couriers/plain-label/how-to-use-plain-labels) if you want to test label generation without using a real carrier.
To print an order, Starshipit needs to know which carrier and service should be used. You can let rules assign this when the order is created, use your default courier setting, or send the carrier details in the label request. Plain Label is useful during testing when you want to see the label generation flow without booking a shipment with a live courier.
## Request example
Use the `order_id` returned from the import quickstart, or use a known test order number. Replace the carrier and service values with the carrier you want Starshipit to use. If you are testing with Plain Label, use the values from your Plain Label setup.
```bash
curl --request POST \
--url https://api.starshipit.com/api/orders/shipment \
--header "StarShipIT-Api-Key: YOUR_API_KEY" \
--header "Ocp-Apim-Subscription-Key: YOUR_SUBSCRIPTION_KEY" \
--header "Content-Type: application/json" \
--data '{
"order_number": "API-TEST-1001",
"carrier": "YOUR_CARRIER",
"carrier_service_code": "YOUR_CARRIER_SERVICE",
"packages": [
{
"weight": 0.5,
"height": 0.1,
"width": 0.1,
"length": 0.1
}
],
"reprint": false
}'
```
## Send the label request
1. Send the request for one test order.
2. Confirm the response includes `"success": true`.
3. Store the returned `tracking_numbers`.
4. Save the `labels` value in the system that will print or display the label.
The `labels` field is returned as a base64 string. Decode the base64 value into the file type returned by your carrier label response before you pass it to a printer or document store.
## Verify the label
Confirm:
- The label belongs to the expected order.
- The tracking number is stored against the source order.
- The carrier and service match the request or Starshipit rule result.
- The shipment is visible in Starshipit.
- Your integration does not create a second label if the same job is retried.
## Handle failures
| Failure | What to do |
| --- | --- |
| Address validation error | Correct the order address, then retry once the data has changed. |
| Carrier service unavailable | Confirm the courier account, destination, and service code. |
| Missing package details | Add weight and dimensions before printing. |
| Duplicate print risk | Check order shipment status before calling the endpoint again. |
## Next steps
- [Use webhooks and tracking updates](/articles/developer-center/starshipit-api/use-webhooks-and-tracking-updates)
- [How to use plain labels](/articles/couriers/plain-label/how-to-use-plain-labels)
- [Troubleshoot API integrations](/articles/developer-center/getting-started/troubleshooting-api-integrations)
- [Orders API reference](/developers/api-reference/starshipit#orders)
---
# Quickstart: Get checkout rates
URL: https://support.starshipit.com/articles/14700000001016-quickstart-get-checkout-rates
Canonical: https://support.starshipit.com/articles/14700000001016-quickstart-get-checkout-rates
Markdown: https://support.starshipit.com/articles/14700000001016-quickstart-get-checkout-rates.md
Updated: 2026-06-18
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Compare checkout rates and delivery services API requests for live courier options.
Use this quickstart to choose between the checkout rates API and delivery services API, then confirm the returned services match your Starshipit courier and rates setup.
Use the [Rates API reference](/developers/api-reference/starshipit#rates) when you need the full request and response models.
## Before you begin
- Confirm your API key and subscription key.
- Confirm at least one courier with rates is set up in Starshipit.
- Confirm sender address, package, and courier service setup is complete.
- Set up checkout rates if you want to use the checkout rates API.
- Use safe test address data for the destination.
## Choose the rates endpoint
| API | Endpoint | What it returns | Use it when |
| --- | --- | --- | --- |
| Checkout rates API | [POST /api/rates](/developers/api-reference/starshipit#endpoint-rates-post-api-rates-get-rates) | Rates that follow your Starshipit checkout rates setup, including checkout rates rules and service settings. | You are showing rates at checkout or want the same behaviour as checkout rates in the app. |
| Delivery services API | [POST /api/deliveryservices](/developers/api-reference/starshipit#endpoint-rates-post-api-deliveryservices-delivery-services) | Available delivery service options for the shipment, regardless of checkout rates setup. | You are checking service options before printing or choosing the best service inside an integration. |
You will not receive checkout rates from `POST /api/rates` unless checkout rates are configured in Starshipit. Returned checkout rates follow your checkout rates settings, including enabled couriers, service configuration, and rules.
## Checkout rates API request
See the [POST /api/rates endpoint reference](/developers/api-reference/starshipit#endpoint-rates-post-api-rates-get-rates) for the complete request and response fields.
```bash
curl --request POST \
--url https://api.starshipit.com/api/rates \
--header "StarShipIT-Api-Key: YOUR_API_KEY" \
--header "Ocp-Apim-Subscription-Key: YOUR_SUBSCRIPTION_KEY" \
--header "Content-Type: application/json" \
--data '{
"sender": {
"street": "184 Exhibition Street",
"suburb": "Melbourne",
"city": "Melbourne",
"state": "VIC",
"post_code": "3000",
"country_code": "AU"
},
"destination": {
"street": "20 George Street",
"suburb": "Sydney",
"city": "Sydney",
"state": "NSW",
"post_code": "2000",
"country_code": "AU"
},
"packages": [
{
"weight": 0.5,
"height": 0.1,
"width": 0.1,
"length": 0.1
}
],
"currency": "AUD"
}'
```
## Delivery services API request
Use delivery services when you want to inspect all available service options for a shipment before printing. See the [POST /api/deliveryservices endpoint reference](/developers/api-reference/starshipit#endpoint-rates-post-api-deliveryservices-delivery-services) for the complete request and response fields.
```bash
curl --request POST \
--url https://api.starshipit.com/api/deliveryservices \
--header "StarShipIT-Api-Key: YOUR_API_KEY" \
--header "Ocp-Apim-Subscription-Key: YOUR_SUBSCRIPTION_KEY" \
--header "Content-Type: application/json" \
--data '{
"destination": {
"street": "20 George Street",
"suburb": "Sydney",
"city": "Sydney",
"state": "NSW",
"post_code": "2000",
"country_code": "AU"
},
"packages": [
{
"weight": 0.5,
"height": 0.1,
"width": 0.1,
"length": 0.1
}
],
"include_pricing": true
}'
```
## Read the rates response
Each returned rate can include a carrier service name, `service_code`, and `total_price`.
```json
{
"rates": [
{
"service_name": "PARCEL POST",
"service_code": "7B05",
"total_price": 12.05
}
],
"success": true
}
```
## Verify rates
Compare the API result with the same shipment details in Starshipit. Confirm:
- The origin and destination addresses match.
- The package weight and dimensions match.
- The same courier services are enabled.
- Checkout rates rules or service filters are not hiding expected services when you use `POST /api/rates`.
- Checkout displays the service name and price your customer should see.
## Common issues
| Issue | What to check |
| --- | --- |
| No checkout rates returned | Confirm checkout rates are set up and enabled for the courier service. |
| No delivery services returned | Confirm the courier has rates available in Starshipit for the destination and package details. |
| Unexpected `service_code` | Check carrier service setup and Starshipit rules. |
| Price differs from Starshipit | Compare sender address, dimensions, surcharges, and service filters. |
| Checkout timeout | Cache cautiously and back off when rate limits are reached. |
## Next steps
- [Get checkout and live rates](/articles/developer-center/starshipit-api/get-live-rates-at-checkout)
- [Testing guidance](/articles/developer-center/getting-started/testing-guidance)
- [Starshipit API fundamentals](/articles/developer-center/starshipit-api/api-fundamentals)
- [Rates API reference](/developers/api-reference/starshipit#rates)
---
# Testing guidance
URL: https://support.starshipit.com/articles/14700000001017-testing-guidance
Canonical: https://support.starshipit.com/articles/14700000001017-testing-guidance
Markdown: https://support.starshipit.com/articles/14700000001017-testing-guidance.md
Updated: 2026-06-18
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Test Starshipit API integrations safely with controlled accounts and data.
Starshipit does not have a separate sandbox environment. Test integrations by using a controlled Starshipit account, safe test data, and a staged rollout before moving real order volume.
## Before you begin
- Confirm which Starshipit account you will use for testing.
- Use the API key from that account.
- Keep API keys out of source control, screenshots, and shared logs.
- Choose order numbers, SKUs, names, phone numbers, and email addresses that are clearly test data.
## Choose a test account
Customers often test with one of these account setups:
| Option | Use when | Notes |
| --- | --- | --- |
| Child account | You already use child accounts or want test activity separated from the main account. | The child account has its own API key, setup, couriers, rules, and data. |
| Second account | You want a separate account for integration testing. | Talk to Starshipit if you need a second account for testing. Use a different API key for each account. |
| Controlled production account | You need to test against the real account setup. | Use obvious test orders and start with a very small volume. |
Your API access tier controls the rate limit. The API key controls which account your requests access.
## Recommended test stages
| Stage | Goal | What to verify |
| --- | --- | --- |
| Authentication | Confirm headers and account access | A read-only request returns expected account data. |
| Order import | Create one safe test order | The order appears with the expected address, items, and shipping method. |
| Rates | Request rates for known package data | Returned services match the same shipment in Starshipit. |
| Label creation | Generate one controlled label, often with Plain Label | Tracking, label data, and shipment status are stored correctly. |
| Webhooks | Receive and process events | Duplicate events do not create duplicate updates. |
| Failure handling | Trigger common errors | Your integration logs each request and response, then retries safely when a recoverable failure occurs. |
## Safe test data
Use test values that are obvious to staff:
- Order numbers such as `API-TEST-1001`.
- Recipient names such as `API Test Recipient`.
- SKUs such as `API-TEST-SKU`.
- Internal email addresses owned by your team.
- Addresses that your courier setup can rate and label.
Avoid real customer names, phone numbers, email addresses, order notes, or delivery instructions during early testing.
## Move toward production
1. Run each quickstart in a child account, second account, or controlled account.
2. Test domestic and international examples if your operation ships internationally.
3. Confirm failed requests are visible to the team that can fix them.
4. Confirm the integration has a retry mechanism for recoverable failures.
5. Confirm retries do not create duplicate orders, labels, emails, or source-system updates.
6. Confirm your production API access and rate limit before switching traffic.
7. Start with a small order volume and monitor response statuses, labels, and webhook processing.
## What to log
We recommend logging every request and response while you test, then keeping enough production logging to investigate failures without exposing secrets:
- Source order ID and Starshipit order ID.
- Endpoint and method.
- Request body, with API keys and other secrets removed.
- Response status and response body.
- Retry count.
- Timestamp.
- Whether the request imported, updated, rated, labelled, manifested, or synced data.
Build retries with backoff for temporary failures such as rate limits, timeouts, and intermittent network errors. For write requests, check the order, shipment, webhook event, or source-system identifier before retrying so the retry does not create duplicates.
## Related guides
- [Quickstart: Import a test order](/articles/developer-center/getting-started/quickstart-import-a-test-order)
- [Quickstart: Print a label by API](/articles/developer-center/getting-started/quickstart-print-a-label-by-api)
- [Troubleshoot API integrations](/articles/developer-center/getting-started/troubleshooting-api-integrations)
---
# Troubleshoot API integrations
URL: https://support.starshipit.com/articles/14700000001010-troubleshoot-api-integrations
Canonical: https://support.starshipit.com/articles/14700000001010-troubleshoot-api-integrations
Markdown: https://support.starshipit.com/articles/14700000001010-troubleshoot-api-integrations.md
Updated: 2026-06-18
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Fix common API request failures and know what to check first.
If an API request fails, start by checking the API family, endpoint, credentials, headers, and request body. Most issues are caused by one of those five things.
Use the [Starshipit API reference](/developers/api-reference/starshipit) or [WMS API reference](/developers/api-reference/wms) to compare request fields, headers, and response examples.
## Common failures
| Response | Likely cause | What to check |
| --- | --- | --- |
| 400 Bad Request | Request parameters or body are invalid | Compare the payload to the reference docs and confirm required fields are present. |
| 401 Unauthorized | Credentials are missing or incorrect | Confirm the API key, subscription key, and environment are correct. |
| 403 Forbidden | The request is not allowed | Check account access, key permissions, and whether you are calling the right API family. |
| 404 Not Found | Wrong endpoint or URL | Confirm the base URL and endpoint path match the documentation. |
| 429 Too Many Requests | The integration exceeded its rate limit | Queue the request and retry with backoff instead of sending repeated immediate retries. |
## What to capture
- The exact endpoint URL.
- The full request headers.
- The request body.
- The response body and status code.
- The workflow you were testing, such as order import, label generation, product sync, rates, or tracking.
## Confirm the fix
Re-run the request with a small test payload after you make a change. If it still fails, compare the request against the relevant product guide before retrying.
---
# Starshipit API guide
URL: https://support.starshipit.com/articles/14700000001003-starshipit-api-guide
Canonical: https://support.starshipit.com/articles/14700000001003-starshipit-api-guide
Markdown: https://support.starshipit.com/articles/14700000001003-starshipit-api-guide.md
Updated: 2026-06-18
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Learn what the Starshipit API supports and choose the right guide for your integration.
Use the Starshipit API to build custom order, shipping, product data, rates, label, manifest, and tracking workflows. It is the best fit for retailers, platforms, 3PLs, WMS providers, middleware teams, and partners that need to connect another system to Starshipit.
## Common use cases
- Import orders, print labels in the Starshipit UI, and update the source system with tracking.
- Import or update orders, print labels outside the Starshipit UI, and return tracking details.
- Retrieve checkout or live rates from your Starshipit courier setup.
- Use Starshipit to import orders, then print labels externally by API.
- Update orders before printing labels.
## Recommended reading order
1. Read [Authentication and access](/articles/developer-center/getting-started/authentication-and-access).
2. Run one safe quickstart:
- [Quickstart: Import a test order](/articles/developer-center/getting-started/quickstart-import-a-test-order)
- [Quickstart: Print a label by API](/articles/developer-center/getting-started/quickstart-print-a-label-by-api)
- [Quickstart: Get checkout rates](/articles/developer-center/getting-started/quickstart-get-checkout-rates)
3. Read [Starshipit API fundamentals](/articles/developer-center/starshipit-api/api-fundamentals) and [Testing guidance](/articles/developer-center/getting-started/testing-guidance).
4. Read [Plan a Starshipit API integration](/articles/developer-center/starshipit-api/plan-a-starshipit-api-integration).
5. Choose a workflow guide:
- [Import orders, print in Starshipit, and update the source system](/articles/developer-center/starshipit-api/import-orders-into-starshipit)
- [Print outside Starshipit and return tracking](/articles/developer-center/starshipit-api/print-outside-starshipit-and-return-tracking)
- [Get checkout and live rates](/articles/developer-center/starshipit-api/get-live-rates-at-checkout)
- [Print labels for orders Starshipit imported](/articles/developer-center/starshipit-api/print-labels-for-orders-starshipit-imported)
- [Update orders before printing](/articles/developer-center/starshipit-api/update-orders-before-printing)
- [Sync product data with Product Catalogue](/articles/developer-center/starshipit-api/sync-product-data-with-product-catalogue)
- [Use webhooks and tracking updates](/articles/developer-center/starshipit-api/use-webhooks-and-tracking-updates)
6. Use the [Starshipit API reference guide](/articles/developer-center/starshipit-api/starshipit-api-reference-guide) to confirm endpoint details.
## Good implementation habits
- Validate your request payload before sending it.
- Log endpoint names, response codes, response bodies, and source-system IDs.
- Re-test with a small sample order before switching traffic over.
- Batch order and product requests where the endpoint supports it.
- Handle `400`, `401`, `403`, `404`, and `429` responses explicitly.
- Retest critical flows after changing your integration, Starshipit account setup, courier setup, or rules.
---
# Starshipit API fundamentals
URL: https://support.starshipit.com/articles/14700000001018-starshipit-api-fundamentals
Canonical: https://support.starshipit.com/articles/14700000001018-starshipit-api-fundamentals
Markdown: https://support.starshipit.com/articles/14700000001018-starshipit-api-fundamentals.md
Updated: 2026-06-18
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Understand Starshipit API base URL, headers, rate limits, pagination, retries, and error handling.
Use these fundamentals when you design an integration for the core Starshipit API. This API is the main Starshipit developer API and covers order import, label printing, rates, manifests, tracking, webhooks, and Product Catalogue workflows.
If you are building against Starshipit WMS inventory or warehouse workflows, use [WMS API fundamentals](/articles/developer-center/starshipit-wms-api/wms-api-fundamentals) instead.
## Base URL and headers
Use the Starshipit API base URL:
```text
https://api.starshipit.com
```
Every JSON request to `https://api.starshipit.com` should include:
| Header | Value |
| --- | --- |
| `Content-Type` | `application/json` |
| `StarShipIT-Api-Key` | Your API key from **Settings > API** |
| `Ocp-Apim-Subscription-Key` | Your subscription key from **Settings > API** |
The API key controls which Starshipit account your request accesses. The subscription key controls your rate limit and API access tier.
## Rate limits
Developer API access allows two requests per second. Production API access requires approval and uses a higher rate limit.
When you receive `429 Too Many Requests`, queue the work and retry with backoff. Do not immediately repeat the same request in a tight loop.
Batch work where possible. For order imports, use `POST /api/orders/import` to create multiple orders in one request instead of sending one request per order.
## Order creation timing
Create orders before the warehouse needs to print labels. After an order is created, Starshipit can run background work such as rules, courier rating, validation, and service selection.
If your integration creates an order and immediately tries to print it, the print request can wait on work that Starshipit could have completed earlier. Creating orders ahead of the fulfilment step keeps printing faster and makes failures easier to investigate before staff need the label.
## Pagination
Some list endpoints use page, page size, skip, status, or search parameters. When you build a sync job:
1. Store the last successful sync time or cursor your workflow can rely on.
2. Request a bounded page size.
3. Process each page before requesting the next page.
4. Stop when the endpoint returns no more records.
5. Log the page or query values used for each request.
## Idempotency and duplicate protection
Design write actions so retries are safe. Starshipit integrations commonly protect against duplicates by checking stable identifiers before repeating a write.
| Action | Duplicate protection |
| --- | --- |
| Create order | Reuse the source order number and check whether the order already exists before retrying. |
| Print label | Check shipment or print status before creating another label. |
| Update order | Apply only fields your source system owns and verify the order status first. |
| Webhook processing | Store processed event identifiers or a stable combination of order number, tracking number, status, and timestamp. |
## API compatibility
Starshipit aims to maintain backwards compatibility for existing API integrations. Avoid building against deprecated endpoints for new work, and retest critical flows after you change your own integration, Starshipit account setup, courier setup, or rules.
## Error handling
Handle these statuses explicitly:
| Status | Meaning | Integration response |
| --- | --- | --- |
| `400` | The request body or parameters are invalid. | Log the validation response and surface the order or product for correction. |
| `401` | Credentials are missing or incorrect. | Stop retries and check both API headers. |
| `403` | The account or key cannot perform the action. | Check API access, permissions, and the endpoint family. |
| `404` | The endpoint or record was not found. | Confirm the base URL, path, and identifiers. |
| `429` | The rate limit was exceeded. | Retry later with backoff. |
| `5xx` | Starshipit or an upstream dependency could not complete the request. | Retry cautiously and alert if failures continue. |
## Timeouts and retries
Use short, bounded retries for transient network or `5xx` failures. Retry only after the underlying condition can plausibly change.
Do not retry forever when the response says the payload is invalid, the order has already been printed, credentials are wrong, or a carrier service is unavailable.
## Related guides
- [Authentication and access](/articles/developer-center/getting-started/authentication-and-access)
- [Testing guidance](/articles/developer-center/getting-started/testing-guidance)
- [Troubleshoot API integrations](/articles/developer-center/getting-started/troubleshooting-api-integrations)
---
# Plan a Starshipit API integration
URL: https://support.starshipit.com/articles/14700000001004-plan-a-starshipit-api-integration
Canonical: https://support.starshipit.com/articles/14700000001004-plan-a-starshipit-api-integration
Markdown: https://support.starshipit.com/articles/14700000001004-plan-a-starshipit-api-integration.md
Updated: 2026-06-18
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Plan the data flow, ownership, and error handling for a Starshipit API integration before you build.
Plan your Starshipit API integration by deciding which system owns each part of the fulfilment workflow, how data moves between systems, and how failures are retried or surfaced to your team.
## Understand what the API uses from Starshipit
The API works with the setup in your Starshipit account. Before you build, confirm which parts of the shipping workflow should already be configured in Starshipit and which parts your integration will send by API.
For example, live rates need enabled couriers, sender addresses, supported destinations, package data, and any service filters or rules that affect which rates are returned. Label generation also depends on courier setup, package details, service selection, customs data for international shipments, and account-level courier requirements.
Use the API to create, update, rate, label, manifest, and sync data against that setup. Do not treat the API as a shortcut around configuring the Starshipit account first.
## Choose the integration pattern
| Pattern | Use when | Typical flow |
| --- | --- | --- |
| Import, print in Starshipit, write back | Starshipit is the shipping workspace and another system owns orders | External system creates orders in Starshipit, staff print labels in Starshipit, then tracking returns by webhook or polling. |
| Print outside Starshipit | Another system owns fulfilment and printing | External system creates or updates the order, calls the label endpoint, stores the label and tracking number, then manifests when ready. |
| Checkout and live rates | Another system needs shipping options before an order is shipped | External system sends destination and package details, displays returned rates, then stores the selected shipping method. |
| Print Starshipit-imported orders externally | Starshipit imports orders through a native integration, but another system prints labels | External system finds the Starshipit order, updates it if required, calls the label endpoint, and stores tracking. |
| Update before printing | Another system needs to correct or enrich an order already in Starshipit | External system finds the order, updates allowed fields, verifies the data, then prints in the UI or through the API. |
| Product data sync | Another system owns product master data | External system syncs SKU, weight, dimensions, customs, and fulfilment fields into Product Catalogue for rates, orders, and customs. |
### Import orders and print in Starshipit
Use this pattern when another system creates orders, but your team works in Starshipit to print labels and manifest shipments.
### Print through another system
Use this pattern when a WMS, ERP, middleware tool, or custom fulfilment system owns the printing workflow and calls Starshipit to generate labels.
## Map the source of truth
Before you build requests, decide which system owns each field.
| Data | Common source of truth | Notes |
| --- | --- | --- |
| Order number | Ecommerce platform, ERP, WMS, or middleware | Keep this stable so updates and tracking can be matched later. |
| Customer and destination address | Source order system | Validate required address fields before creating labels. |
| Shipping method | Source system or Starshipit rules | You can map shipping methods to carrier services through Starshipit rules. |
| Product dimensions and customs data | Product Catalogue, ERP, PIM, or ecommerce platform | Use Product Catalogue when Starshipit should enrich missing product data. |
| Carrier and service | Starshipit rules or API update flow | Do not hard-code carrier logic unless your operation requires it. |
| Tracking number | Starshipit after label creation | Use webhooks where possible, or poll tracking and order endpoints when webhooks are unavailable or missed. |
## Build in stages
1. Confirm authentication and rate limits.
2. Create one test order with the smallest realistic payload.
3. Confirm the order appears in Starshipit with the expected address, items, and shipping method.
4. Add product data, packages, customs fields, and metadata.
5. Generate a label in a controlled test flow.
6. Add webhook handling or polling for tracking writeback.
7. Add retry handling and operational logging.
## Design around rate limits and background work
Batch order imports where possible instead of sending one request for every order in a tight loop. Batching keeps request volume lower, makes retries easier to reason about, and reduces the chance that a busy integration exceeds its rate limit.
Create orders before the warehouse needs to print them. Starshipit can run background work after an order is created, including rules, address checks, courier rating, and service selection. If your integration creates an order and immediately tries to print it, the print flow may wait on work that could have already happened earlier in the fulfilment process.
## Design for support
Log enough detail to investigate failures without exposing secrets:
- Source-system order ID.
- Starshipit order ID, when available.
- Endpoint and HTTP method.
- Response status and response body.
- Retry count.
- Timestamp.
- Whether the request created, updated, labelled, manifested, or synced data.
## Verify before production
Test with domestic and international orders, at least one multi-item order, and at least one failure case. Confirm your team knows where failed requests appear and how to replay or correct them.
---
# Automate API order import, printing, and writeback
URL: https://support.starshipit.com/articles/14700000001005-automate-api-order-import-printing-and-writeback
Canonical: https://support.starshipit.com/articles/14700000001005-automate-api-order-import-printing-and-writeback
Markdown: https://support.starshipit.com/articles/14700000001005-automate-api-order-import-printing-and-writeback.md
Updated: 2026-06-18
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Import orders into Starshipit, print labels in the Starshipit UI, and update the source system with tracking.
Import orders into Starshipit when another system receives or manages orders, but your team prints labels in the Starshipit UI. After printing, send tracking and shipment status back to the source system.
## Before you begin
- Confirm your API key and subscription key.
- Confirm your team will print labels in the Starshipit UI.
- Map required order, destination, item, and package fields.
- Confirm how your source system marks an order as ready to ship.
## Recommended workflow
1. Retrieve ready-to-ship orders from your ecommerce, ERP, WMS, marketplace, middleware, or custom platform.
2. Create the order in Starshipit with [POST /api/orders](/developers/api-reference/starshipit#endpoint-orders-post-api-orders-create-order), or batch multiple orders with [POST /api/orders/import](/developers/api-reference/starshipit#endpoint-orders-post-api-orders-import-create-orders).
3. Confirm the order appears in Starshipit with [GET /api/orders/unshipped](/developers/api-reference/starshipit#endpoint-orders-get-api-orders-unshipped-list-orders-unshipped), [GET /api/orders/search](/developers/api-reference/starshipit#endpoint-orders-get-api-orders-search-phrase-john-20smith-search-orders), or the Starshipit UI.
4. Your team prints labels in the Starshipit UI.
5. Your team manifests shipments in the Starshipit UI when the operational process is ready.
6. Starshipit creates tracking details for the shipment.
7. Update the source system by receiving webhooks or polling [GET /api/track](/developers/api-reference/starshipit#endpoint-tracking-get-api-track-tracking).
## Endpoint map
| Step | Endpoint | Use it to |
| --- | --- | --- |
| Create one order | [POST /api/orders](/developers/api-reference/starshipit#endpoint-orders-post-api-orders-create-order) | Import a single source order into Starshipit. |
| Create many orders | [POST /api/orders/import](/developers/api-reference/starshipit#endpoint-orders-post-api-orders-import-create-orders) | Batch ready-to-ship orders where batching fits your workflow. |
| Check imported orders | [GET /api/orders/unshipped](/developers/api-reference/starshipit#endpoint-orders-get-api-orders-unshipped-list-orders-unshipped) or [GET /api/orders/search](/developers/api-reference/starshipit#endpoint-orders-get-api-orders-search-phrase-john-20smith-search-orders) | Confirm the order exists before staff print labels. |
| Receive tracking updates | `POST /callback/` | Let Starshipit notify your system after tracking changes. |
| Poll tracking if needed | [GET /api/track](/developers/api-reference/starshipit#endpoint-tracking-get-api-track-tracking) | Reconcile tracking when webhooks are unavailable or missed. |
Use the [Starshipit API reference](/developers/api-reference/starshipit) for the latest request examples and the [Models section](/developers/api-reference/starshipit/models) for order, item, package, label, and error fields.
## Create one order
Use `POST /api/orders` when your integration creates one order at a time.
```bash
curl --request POST \
--url https://api.starshipit.com/api/orders \
--header "StarShipIT-Api-Key: YOUR_API_KEY" \
--header "Ocp-Apim-Subscription-Key: YOUR_SUBSCRIPTION_KEY" \
--header "Content-Type: application/json" \
--data '{
"order": {
"order_number": "10001",
"reference": "Online order",
"shipping_method": "Standard",
"destination": {
"name": "Jane Smith",
"phone": "0200000000",
"street": "20 George Street",
"suburb": "Sydney",
"state": "NSW",
"post_code": "2000",
"country": "Australia"
},
"items": [
{
"description": "T-shirt",
"quantity": 1,
"sku": "TSHIRT-BLACK-M",
"weight": 0.3,
"value": 25
}
]
}
}'
```
## Batch orders where possible
Use `POST /api/orders/import` when your integration imports multiple ready-to-ship orders. Batching reduces request volume and helps avoid rate limit issues.
```bash
curl --request POST \
--url https://api.starshipit.com/api/orders/import \
--header "StarShipIT-Api-Key: YOUR_API_KEY" \
--header "Ocp-Apim-Subscription-Key: YOUR_SUBSCRIPTION_KEY" \
--header "Content-Type: application/json" \
--data '{
"orders": [
{
"order_number": "10001",
"reference": "Online order",
"shipping_method": "Standard",
"destination": {
"name": "Jane Smith",
"street": "20 George Street",
"suburb": "Sydney",
"state": "NSW",
"post_code": "2000",
"country": "Australia"
},
"items": [
{
"description": "T-shirt",
"quantity": 1,
"sku": "TSHIRT-BLACK-M"
}
]
},
{
"order_number": "10002",
"reference": "Online order",
"shipping_method": "Express",
"destination": {
"name": "Alex Lee",
"street": "1 Queen Street",
"suburb": "Auckland",
"post_code": "1010",
"country": "New Zealand"
},
"items": [
{
"description": "Socks",
"quantity": 2,
"sku": "SOCKS-BLUE"
}
]
}
]
}'
```
Create orders before the warehouse needs to print labels. Starshipit runs background work such as rules, courier rating, validation, and service selection after orders are created, so creating orders early can keep the print step faster.
## When to use this pattern
Use this pattern when Starshipit is the shipping workspace and the external system is the order source. It is a good fit when warehouse staff already use Starshipit to review orders, choose services, print labels, manifest shipments, and troubleshoot carrier errors.
## Map order data
At minimum, your integration usually needs to map:
| Data | Why it matters |
| --- | --- |
| Order number | Lets Starshipit and your source system refer to the same order. |
| Destination address | Required for rates and labels. |
| Customer contact details | Used for courier data, notifications, and support. |
| Items | Required for packing, customs, and downstream fulfilment workflows. |
| Shipping method | Can be used by Starshipit rules to choose carrier and service. |
| Packages | Useful when the source system already knows parcel weights and dimensions. |
| Optional order enrichment | Include supported order, item, package, customs, billing, sender, and destination fields when your source system owns that data. Examples include `shipping_freight_value`, `dangerous_goods`, `tax_numbers`, `customs`, `brand`, `material`, `bin_location`, package `name`, and `packaging_type`. |
The API reference examples intentionally show a fuller payload than the minimum required fields. You can include supported optional attributes from the [Models section](/developers/api-reference/starshipit/models) when they apply to your workflow.
:::note
Order tags are managed through the Tags endpoints after the order exists. Use `POST /api/tags/order` to add tags and `DELETE /api/tags/order` to remove tags.
:::
:::important
For international shipments, include item descriptions, values, weights, tariff or HS codes, and country of origin where possible. Missing customs data can stop label creation or delay clearance.
:::
## Verify the import
After creating test orders, confirm:
- The order appears in Starshipit.
- The destination address is complete.
- Items and quantities match the source order.
- Shipping method and any metadata are present.
- Starshipit rules behave as expected.
## Common issues
| Issue | What to check |
| --- | --- |
| Duplicate order error | Confirm whether the order was already imported and whether you should update it instead. |
| Missing customs fields | Check item value, description, country of origin, tariff code, and weight. |
| Wrong carrier selection | Check the shipping method sent to Starshipit and the matching rules in Starshipit. |
| Slow order availability | Create orders before the warehouse needs to print labels so rules and validation have time to run. |
## Related guides
- [Print outside Starshipit and return tracking](/articles/developer-center/starshipit-api/print-outside-starshipit-and-return-tracking)
- [Update orders before printing](/articles/developer-center/starshipit-api/update-orders-before-printing)
- [Use webhooks and tracking updates](/articles/developer-center/starshipit-api/use-webhooks-and-tracking-updates)
- [Starshipit API reference](/developers/api-reference/starshipit)
---
# Print outside Starshipit and return tracking
URL: https://support.starshipit.com/articles/14700000001006-print-outside-starshipit-and-return-tracking
Canonical: https://support.starshipit.com/articles/14700000001006-print-outside-starshipit-and-return-tracking
Markdown: https://support.starshipit.com/articles/14700000001006-print-outside-starshipit-and-return-tracking.md
Updated: 2026-06-18
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Import or update orders, print labels outside the Starshipit UI, and return tracking details to another system.
Print outside the Starshipit UI when your ERP, WMS, middleware, or custom platform drives fulfilment and needs Starshipit to generate the courier label and tracking details by API.
## Before you begin
- Import or identify the order you want to ship.
- Confirm the order has a valid destination address.
- Confirm a carrier and service can be selected by Starshipit rules or by your integration.
- Confirm package weight and dimensions are available.
- Decide where the label file and tracking number will be stored.
## Recommended workflow
1. Create the order in Starshipit with [POST /api/orders](/developers/api-reference/starshipit#endpoint-orders-post-api-orders-create-order), or update an existing unprinted order with [PUT /api/orders](/developers/api-reference/starshipit#endpoint-orders-put-api-orders-update-order).
2. Confirm the order has the correct address, items, package details, shipping method, carrier, and service.
3. Trigger label generation with [POST /api/orders/shipment](/developers/api-reference/starshipit#endpoint-shipments-post-api-orders-shipment-print-label), or use [POST /api/orders/shipments](/developers/api-reference/starshipit#endpoint-shipments-post-api-orders-shipments-print-labels) for a batch print flow.
4. Store the returned label file or label URL in your fulfilment system.
5. Store the returned tracking number against the source order.
6. Manifest shipments with [POST /api/manifests/shipments](/developers/api-reference/starshipit#endpoint-manifests-post-api-manifests-shipments-manifest-orders) when your operational process is ready.
7. Send tracking to the customer or source platform, or reconcile it later with [GET /api/track](/developers/api-reference/starshipit#endpoint-tracking-get-api-track-tracking).
## Endpoint map
[Open the Starshipit API reference](/developers/api-reference/starshipit#orders) for request fields and response models.
| Step | Endpoint | Use it to |
| --- | --- | --- |
| Create the order | [POST /api/orders](/developers/api-reference/starshipit#endpoint-orders-post-api-orders-create-order) | Add the order Starshipit will label. |
| Update the order | [PUT /api/orders](/developers/api-reference/starshipit#endpoint-orders-put-api-orders-update-order) or [PUT /api/orders/update](/developers/api-reference/starshipit#endpoint-orders-put-api-orders-update-update-orders) | Correct address, package, customs, or shipping data before printing. |
| Print one label | [POST /api/orders/shipment](/developers/api-reference/starshipit#endpoint-shipments-post-api-orders-shipment-print-label) | Generate one label and tracking response. |
| Print multiple labels | [POST /api/orders/shipments](/developers/api-reference/starshipit#endpoint-shipments-post-api-orders-shipments-print-labels) | Generate labels in a batch flow where appropriate. |
| Manifest shipments | [POST /api/manifests/shipments](/developers/api-reference/starshipit#endpoint-manifests-post-api-manifests-shipments-manifest-orders) | Manifest shipments when your operational process is ready. |
## Example WMS-driven flow
Use this variation when a WMS or fulfilment system owns picking and packing, but Starshipit creates the courier label.
1. Orders are imported into Starshipit through a native ecommerce, marketplace, or platform integration.
2. The WMS finds the Starshipit order with [GET /api/orders](/developers/api-reference/starshipit#endpoint-orders-get-api-orders-get-order-s) or [GET /api/orders/search](/developers/api-reference/starshipit#endpoint-orders-get-api-orders-search-phrase-john-20smith-search-orders).
3. Users pick the order and make any required changes in the WMS, such as changing weight or package count.
4. The WMS updates the unprinted order in Starshipit with [PUT /api/orders](/developers/api-reference/starshipit#endpoint-orders-put-api-orders-update-order).
5. The WMS prints the courier label with [POST /api/orders/shipment](/developers/api-reference/starshipit#endpoint-shipments-post-api-orders-shipment-print-label).
6. The WMS manifests shipments with [POST /api/manifests/shipments](/developers/api-reference/starshipit#endpoint-manifests-post-api-manifests-shipments-manifest-orders).
7. The WMS stores tracking from the label response, receives webhooks, or reconciles later with [GET /api/track](/developers/api-reference/starshipit#endpoint-tracking-get-api-track-tracking).
## Decide where fulfilment happens
| Fulfilment model | Best fit |
| --- | --- |
| Staff print in Starshipit | Teams that use Starshipit as the operational shipping screen. |
| External system prints labels | Warehouses that pick, pack, and print from a WMS, ERP, or custom tool. |
| Hybrid | Teams that fulfil some orders in Starshipit and some orders externally. |
## When to use this pattern
Use this pattern when the external system owns the warehouse workflow. Starshipit still handles carrier rules, label generation, tracking, manifests, and courier integrations, but staff do not need to open the Starshipit UI for each shipment.
## Handle label failures
Label creation can fail even when order creation succeeds. Common causes include invalid address data, missing package details, unavailable carrier services, missing customs data, or account-level courier configuration issues.
When label creation fails:
1. Log the response body and the source order ID.
2. Show the failure to the operations team.
3. Allow the order data to be corrected.
4. Retry only after the underlying issue has changed.
## Verify the label flow
Confirm the generated label can be opened or printed, the tracking number is stored in your source system, and the shipment appears in Starshipit with the expected carrier and service.
## Related guides
- [Import orders, print in Starshipit, and update the source system](/articles/developer-center/starshipit-api/import-orders-into-starshipit)
- [Print labels for orders Starshipit imported](/articles/developer-center/starshipit-api/print-labels-for-orders-starshipit-imported)
- [Update orders before printing](/articles/developer-center/starshipit-api/update-orders-before-printing)
- [Starshipit API reference](/developers/api-reference/starshipit#orders)
---
# Get checkout and live rates
URL: https://support.starshipit.com/articles/14700000001011-get-checkout-and-live-rates
Canonical: https://support.starshipit.com/articles/14700000001011-get-checkout-and-live-rates
Markdown: https://support.starshipit.com/articles/14700000001011-get-checkout-and-live-rates.md
Updated: 2026-06-18
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Choose checkout rates or delivery services API requests for live courier options.
Use Starshipit rates when an ecommerce platform, checkout, ERP, middleware, or custom system needs courier options before an order is shipped. Choose the endpoint based on whether you want checkout-rate behaviour or all available delivery service options.
## Before you begin
- Confirm your API key and subscription key.
- Enable at least one courier with rates in Starshipit.
- Confirm sender and destination address data is available.
- Confirm item weights, dimensions, and values are available or can be completed from Product Catalogue data.
- Decide whether the requesting system needs checkout-rate results or all available delivery services.
If you are using the checkout rates API, set up checkout rates in Starshipit before calling the API. Use [Set up rates at checkout](/articles/rates-at-checkout/set-up-guides/set-up-rates-at-checkout) to confirm couriers, services, rules, and checkout-rate settings are ready.
## Choose the endpoint
| API | Endpoint | Behaviour |
| --- | --- | --- |
| Checkout rates API | [POST /api/rates](/developers/api-reference/starshipit#endpoint-rates-post-api-rates-get-rates) | Returns rates based on your Starshipit checkout rates setup. You must configure checkout rates first, and returned rates follow your checkout rates rules and enabled services. |
| Delivery services API | [POST /api/deliveryservices](/developers/api-reference/starshipit#endpoint-rates-post-api-deliveryservices-delivery-services) | Returns delivery service options for the shipment regardless of checkout rates setup. Use this when you want to check options before printing. |
## Recommended workflow
1. Collect the cart, order, destination, and package details from the requesting system.
2. Send a checkout rates or delivery services request to Starshipit.
3. Display the returned carrier services and prices in the checkout or source system.
4. Store the selected shipping method with the order.
5. Send the selected shipping method when you create or update the order in Starshipit.
6. Use Starshipit rules to map shipping methods to carrier services where needed.
## Endpoint map
| Step | Endpoint | Use it to |
| --- | --- | --- |
| Retrieve checkout rates | [POST /api/rates](/developers/api-reference/starshipit#endpoint-rates-post-api-rates-get-rates) | Get rates using your checkout rates configuration. |
| Check delivery services | [POST /api/deliveryservices](/developers/api-reference/starshipit#endpoint-rates-post-api-deliveryservices-delivery-services) | Confirm available delivery services before printing or service selection. |
| Create the order after checkout | [POST /api/orders](/developers/api-reference/starshipit#endpoint-orders-post-api-orders-create-order) | Store the selected shipping method with the order. |
| Update the order after checkout | [PUT /api/orders](/developers/api-reference/starshipit#endpoint-orders-put-api-orders-update-order) | Apply a changed shipping method or final package details. |
Use the [Rates endpoint reference](/developers/api-reference/starshipit#rates) for request and response examples.
## Data that affects rates
| Data | Why it matters |
| --- | --- |
| Sender address | Determines origin, available couriers, and zones. |
| Destination address | Determines service availability and price. |
| Item weight and dimensions | Improves rate accuracy and packaging decisions. |
| Package details | Required when rates depend on parcel size or weight. |
| Product Catalogue data | Can fill missing product dimensions, weights, values, and customs fields. |
| Courier setup | Rates depend on enabled couriers and account configuration in Starshipit. |
## Verify rates
Compare test API rates against the same shipment details in Starshipit. If rates differ, check sender address, destination address, package dimensions, service filters, surcharges, and whether Product Catalogue data is being applied.
## Common issues
| Issue | What to check |
| --- | --- |
| No checkout rates returned | Confirm checkout rates are set up, the courier is enabled for checkout rates, the destination is supported, and package data is valid. |
| No delivery services returned | Confirm the courier has rates available in Starshipit for the destination and package details. |
| Rate is different from expected | Compare package dimensions, weights, address data, surcharges, checkout rates rules, and service filters. |
| Missing services | Check whether the courier account supports the destination and service type. |
| Checkout timeout | Cache cautiously, reduce unnecessary retries, and handle rate-limit responses. |
## Related guides
- [Sync product data with Product Catalogue](/articles/developer-center/starshipit-api/sync-product-data-with-product-catalogue)
- [Set up rates at checkout](/articles/rates-at-checkout/set-up-guides/set-up-rates-at-checkout)
- [Import orders, print in Starshipit, and update the source system](/articles/developer-center/starshipit-api/import-orders-into-starshipit)
- [Starshipit API reference](/developers/api-reference/starshipit)
---
# Update orders before printing
URL: https://support.starshipit.com/articles/14700000001013-update-orders-before-printing
Canonical: https://support.starshipit.com/articles/14700000001013-update-orders-before-printing
Markdown: https://support.starshipit.com/articles/14700000001013-update-orders-before-printing.md
Updated: 2026-06-18
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Update order details in Starshipit before printing labels through the UI or API.
Update orders before printing when another system needs to correct, enrich, or finalise order data after the order is already in Starshipit but before a label is generated.
## Before you begin
- Confirm the order already exists in Starshipit.
- Confirm the order has not already been printed.
- Identify the fields your integration is allowed to change.
- Decide which system is the source of truth for each changed field.
## Common update scenarios
| Scenario | Examples |
| --- | --- |
| Address correction | Change suburb, postcode, delivery instructions, company name, or contact details. |
| Shipping change | Update shipping method, carrier, service, signature requirement, or delivery option. |
| Package finalisation | Add final weight, dimensions, package count, or packaging type after packing. |
| Customs enrichment | Add item value, description, tariff code, country of origin, or tax details. |
| Warehouse changes | Adjust quantities, remove unavailable items, update metadata, or add an internal order `note` before printing. |
| Commercial enrichment | Update billing or sold-to details, customs data, return fields, carrier service names, COD values, duties, tax amounts, and shipping price fields when your integration is the source of truth. |
## Recommended workflow
1. Find the order in Starshipit.
2. Check the order status before changing it.
3. Apply only the fields your source system owns.
4. Re-read or verify the order if the next action depends on the updated data.
5. Print the label in the Starshipit UI or through the API.
6. Store tracking and shipment details in the source system.
## Endpoint map
[Open the Starshipit API reference](/developers/api-reference/starshipit#orders) for request fields and response models.
| Step | Endpoint | Use it to |
| --- | --- | --- |
| Find the order | [GET /api/orders/search](/developers/api-reference/starshipit#endpoint-orders-get-api-orders-search-phrase-john-20smith-search-orders) or [GET /api/orders](/developers/api-reference/starshipit#endpoint-orders-get-api-orders-get-order-s) | Confirm the order exists and is the right record. |
| Update one order | [PUT /api/orders](/developers/api-reference/starshipit#endpoint-orders-put-api-orders-update-order) | Apply a targeted correction before printing. |
| Update many orders | [PUT /api/orders/update](/developers/api-reference/starshipit#endpoint-orders-put-api-orders-update-update-orders) or [PUT /api/orders/batchupdate](/developers/api-reference/starshipit#endpoint-orders-put-api-orders-batchupdate-batch-update-orders) | Apply controlled updates in bulk workflows. |
| Add or remove order tags | [POST /api/tags/order](/developers/api-reference/starshipit#endpoint-tags-post-api-tags-order-add-order-tags) or [DELETE /api/tags/order](/developers/api-reference/starshipit#endpoint-tags-delete-api-tags-order-delete-order-tags) | Apply user-defined tags to an order after it exists in Starshipit. |
| Print after update | [POST /api/orders/shipment](/developers/api-reference/starshipit#endpoint-shipments-post-api-orders-shipment-print-label) | Generate the label after verification. |
The [Update Order model](/developers/api-reference/starshipit/models/update-order---order-model) lists the supported optional fields, including `note`, `metadatas`, `billing`, `customs`, `dangerous_goods_type`, `shipping_freight_value`, `total_shipping_price`, `duties_amount`, `tax_amount`, `return_order`, `outgoing_order_id`, `carrier_service_name`, `is_fully_packed`, `bbx_parent_id`, `bbx_pallet_id`, `nfe_key`, and `cod_value`.
:::note
After an order has been printed, Starshipit only allows a small update set: `order_id`, `order_number`, `status`, `is_manifested`, and `note`. Do not rely on the update endpoints to change address, carrier, service, package, or customs details after printing.
:::
## If the order has already been printed
We do not recommend updating printed order details. If the customer, warehouse, or source system needs to change address, carrier, service, package, or customs data after printing, use an operational redo flow instead.
1. Stop the parcel from being shipped with the old label.
2. If the shipment has not been manifested, archive or cancel the printed label where your courier and workflow allow it.
3. Redo the order in Starshipit, or create a replacement order with the corrected details.
4. Print a new label and store the new tracking number in the source system.
5. Make sure the old tracking number is not sent to the customer or marketplace as the active shipment.
For the UI process, see [Archiving and removing orders](/articles/orders-manifests-reports/orders/archiving-removing-orders) and [Cancel or archive labels in Starshipit](/articles/printing-labels-packing-slips/labels/cancel-or-archive-labels-in-starshipit).
:::warning
Do not silently overwrite shipping, package, or customs data after a label has been generated. Make the exception visible to the team that owns fulfilment.
:::
## Verify the update
Confirm the changed fields appear correctly in Starshipit before printing. For package, service, address, and customs changes, test both successful updates and validation failures.
## Related guides
- [Import orders, print in Starshipit, and update the source system](/articles/developer-center/starshipit-api/import-orders-into-starshipit)
- [Print outside Starshipit and return tracking](/articles/developer-center/starshipit-api/print-outside-starshipit-and-return-tracking)
- [Print labels for orders Starshipit imported](/articles/developer-center/starshipit-api/print-labels-for-orders-starshipit-imported)
- [Starshipit API reference](/developers/api-reference/starshipit#orders)
---
# Print labels for orders Starshipit imported
URL: https://support.starshipit.com/articles/14700000001012-print-labels-for-orders-starshipit-imported
Canonical: https://support.starshipit.com/articles/14700000001012-print-labels-for-orders-starshipit-imported
Markdown: https://support.starshipit.com/articles/14700000001012-print-labels-for-orders-starshipit-imported.md
Updated: 2026-06-18
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Use the API to print labels for orders that Starshipit imported from a connected ecommerce platform or marketplace.
Use this pattern when Starshipit imports orders through a native integration, but another system needs to trigger label generation and retrieve the label and tracking details by API.
## Before you begin
- Confirm the order already exists in Starshipit.
- Store enough source-system data to find the Starshipit order, such as order number or order ID.
- Confirm the order is ready to ship.
- Confirm shipping method, carrier rules, package details, and customs data are available.
- Decide where the returned label and tracking number will be stored.
## Recommended workflow
1. Let Starshipit import the order from the connected platform.
2. Find the order in Starshipit with [GET /api/orders/search](/developers/api-reference/starshipit#endpoint-orders-get-api-orders-search-phrase-john-20smith-search-orders), [GET /api/orders](/developers/api-reference/starshipit#endpoint-orders-get-api-orders-get-order-s), or [GET /api/orders/unshipped](/developers/api-reference/starshipit#endpoint-orders-get-api-orders-unshipped-list-orders-unshipped).
3. Update the unprinted order if required with [PUT /api/orders](/developers/api-reference/starshipit#endpoint-orders-put-api-orders-update-order).
4. Print the label with [POST /api/orders/shipment](/developers/api-reference/starshipit#endpoint-shipments-post-api-orders-shipment-print-label).
5. Store the returned label file or label URL in the external system.
6. Store the tracking number against the source order.
7. Manifest the shipment with [POST /api/manifests/shipments](/developers/api-reference/starshipit#endpoint-manifests-post-api-manifests-shipments-manifest-orders) when your process is ready.
## Endpoint map
[Open the Starshipit API reference](/developers/api-reference/starshipit#orders) for request fields and response models.
| Step | Endpoint | Use it to |
| --- | --- | --- |
| Find the order | [GET /api/orders/search](/developers/api-reference/starshipit#endpoint-orders-get-api-orders-search-phrase-john-20smith-search-orders) or [GET /api/orders](/developers/api-reference/starshipit#endpoint-orders-get-api-orders-get-order-s) | Locate the order Starshipit imported from a connected platform. |
| Update before printing | [PUT /api/orders](/developers/api-reference/starshipit#endpoint-orders-put-api-orders-update-order) | Add final address, package, customs, or service data. |
| Print the label | [POST /api/orders/shipment](/developers/api-reference/starshipit#endpoint-shipments-post-api-orders-shipment-print-label) | Generate the label and tracking number. |
| Manifest when ready | [POST /api/manifests/shipments](/developers/api-reference/starshipit#endpoint-manifests-post-api-manifests-shipments-manifest-orders) | Manifest printed shipments in your operational flow. |
## When to use this pattern
Use this pattern when Starshipit already has the best order import connection, but your warehouse or middleware system owns the print action. For example, a platform integration imports orders into Starshipit, then a WMS calls Starshipit to generate the courier label during packing.
## Verify the flow
Confirm that:
- The external system finds the correct Starshipit order.
- The order is not printed twice.
- The label belongs to the expected carrier and service.
- The returned tracking number is stored against the correct source order.
- Failed label attempts are visible to the operations team.
## Common issues
| Issue | What to check |
| --- | --- |
| Order cannot be found | Confirm the source order number matches the Starshipit order number or reference. |
| Label prints with the wrong service | Check Starshipit rules, shipping method, carrier, and service mapping. |
| Duplicate labels | Make the print action idempotent and check shipment status before printing again. |
| Missing customs or package data | Update the order before printing or complete the data in Starshipit. |
## Related guides
- [Update orders before printing](/articles/developer-center/starshipit-api/update-orders-before-printing)
- [Print outside Starshipit and return tracking](/articles/developer-center/starshipit-api/print-outside-starshipit-and-return-tracking)
- [Use webhooks and tracking updates](/articles/developer-center/starshipit-api/use-webhooks-and-tracking-updates)
- [Starshipit API reference](/developers/api-reference/starshipit#orders)
---
# Sync product data with Product Catalogue
URL: https://support.starshipit.com/articles/14700000001007-sync-product-data-with-product-catalogue
Canonical: https://support.starshipit.com/articles/14700000001007-sync-product-data-with-product-catalogue
Markdown: https://support.starshipit.com/articles/14700000001007-sync-product-data-with-product-catalogue.md
Updated: 2026-06-18
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Sync SKU, dimensions, weight, customs, and fulfilment data into Starshipit's Product Catalogue through the Starshipit API.
Sync product data with Starshipit's Product Catalogue when another system owns product master data and Starshipit needs that data for fulfilment, customs, packing, or live rates.
## What to sync
Product Catalogue data commonly includes:
- SKU.
- Product name or description.
- Weight and dimensions.
- HS or tariff code.
- Country of origin.
- Customs description.
- Cost price or declared value fields.
- Bin location or fulfilment location.
## Choose your source of truth
Decide whether Starshipit should replace missing order data with Product Catalogue values or whether incoming order data should remain the source of truth.
| Field type | Common source | Notes |
| --- | --- | --- |
| SKU | ERP, ecommerce platform, PIM, or WMS | SKUs must match consistently for catalogue data to apply. |
| Weight and dimensions | Product Catalogue, ERP, PIM, or ecommerce platform | Accurate dimensions improve rates and packaging decisions. |
| Customs data | Product Catalogue, ERP, or PIM | Missing customs data can block international labels. |
| Bin location | WMS, ERP, or Product Catalogue | Useful for picking and packing workflows. |
## Recommended workflow
1. Export or retrieve product data from the source system.
2. Normalise SKUs before sending data to Starshipit.
3. Sync a small product set first.
4. Confirm the Product Catalogue shows the expected values.
5. Create or import a test order with matching SKUs.
6. Confirm Starshipit applies the catalogue data in the order, checkout, or fulfilment workflow you are testing.
7. Expand the sync once the mapping is correct.
## Endpoint map
[Open the Starshipit API reference](/developers/api-reference/starshipit#products) for request fields and response models.
| Step | Endpoint | Use it to |
| --- | --- | --- |
| List products | `GET /api/products` | Reconcile Product Catalogue data with your source system. |
| Add product data | `POST /api/products` | Create new Product Catalogue records. |
| Update product data | `PUT /api/products/update` | Keep SKU, weight, dimensions, customs, and fulfilment fields current. |
| Delete product data | `DELETE /api/products/delete` | Remove records only when your source system confirms they should no longer sync. |
| Download CSV template | `GET /api/products/template` | Get the current Product Catalogue import template. |
| Import product CSV | `POST /api/products/import` | Import Product Catalogue records from a CSV file. |
| Export product CSV | `GET /api/products/export` | Export Product Catalogue records for reconciliation or backup. |
## Keep product sync reliable
- Use stable SKUs and avoid whitespace or casing differences.
- Send complete product records where your source system can provide them.
- Log product IDs, SKUs, request status, and response errors.
- Treat repeated validation errors as data-quality issues, not retry-only issues.
- Reconcile a sample of synced products after each major mapping change.
## Related Starshipit guides
- [Product Catalogue](/articles/integrations/product-catalogue/product-catalogue)
- [Add and manage products in the Product Catalogue](/articles/integrations/product-catalogue/add-and-manage-products-in-the-product-catalogue)
- [Configure Product Catalogue settings](/articles/integrations/product-catalogue/configure-product-catalogue-settings)
- [Starshipit API reference](/developers/api-reference/starshipit#products)
---
# Use webhooks and tracking updates
URL: https://support.starshipit.com/articles/14700000001008-use-webhooks-and-tracking-updates
Canonical: https://support.starshipit.com/articles/14700000001008-use-webhooks-and-tracking-updates
Markdown: https://support.starshipit.com/articles/14700000001008-use-webhooks-and-tracking-updates.md
Updated: 2026-06-18
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Use Starshipit webhooks and tracking lookups to keep another system updated after labels are created.
Use webhooks or tracking lookups when another system needs to know that an order has shipped, manifested, or received updated delivery tracking information. This is the canonical Developer Center guide for tracking writeback, webhook setup, receiver behaviour, and polling fallbacks.
## Choose webhook or polling
| Approach | Use when | Trade-off |
| --- | --- | --- |
| Webhooks | Your system can receive inbound HTTP requests | Faster updates, but you need reliable receiving, retries, and deduplication. |
| Polling | Your system cannot receive webhooks or needs scheduled reconciliation | Simpler infrastructure, but updates are less immediate and request volume is higher. |
| Hybrid | You want real-time updates plus a safety net | Webhooks handle normal updates and polling catches missed events. |
## Recommended webhook workflow
1. In Starshipit, go to **Settings > Customer Notifications** or **Settings > Tracking & notifications**.
2. Add your HTTPS notification endpoint URL.
3. Optional: add or generate a webhook secret key.
4. Print or update a test shipment so Starshipit can send a webhook event.
5. Receive the webhook payload in your system.
6. Validate the payload shape and required identifiers.
7. Validate the `X-Starshipit-Signature` header if you configured a secret.
8. Match the event to your source order.
9. Update the source system with tracking or shipment status.
10. Store the event ID, order number, tracking number, and received timestamp.
11. Ignore duplicate events that have already been processed.
## Supported webhook data
Starshipit webhooks are tracking and shipment notification events. Payloads include order, carrier, tracking, and status fields.
| Field | Type | Description |
| --- | --- | --- |
| `order_number` | string | The order number from the source ecommerce platform or integration. |
| `carrier_name` | string | The courier used for the shipment. |
| `carrier_service` | string | The courier service used for the shipment. |
| `shipment_date` | datetime | The local date when the label was generated. |
| `tracking_number` | string | The courier tracking number. |
| `tracking_status` | string | The latest tracking status from Starshipit or the courier. |
| `last_updated_date` | datetime | The latest tracking update timestamp. |
Supported tracking statuses include `Printed`, `Dispatched`, `InTransit`, `OutForDelivery`, `Delivered`, `PickupInStore`, `AttemptedDelivery`, `Exception`, `AwaitingCollection`, `Cancelled`, `Manifested`, `ReturnPickupPrinted`, `ReturnDropoffPrinted`, `DroppedOff`, `ReturnLink`, and `ReturnLabel`.
## Recommended polling workflow
1. Store the Starshipit order ID or order number when you create or import the order.
2. Query the relevant order or tracking endpoint on a schedule.
3. Update only records that changed since your last successful sync.
4. Back off when you receive rate-limit responses.
5. Run a periodic reconciliation job for recently shipped orders.
## Endpoint map
[Open the Starshipit API reference](/developers/api-reference/starshipit#tracking) for tracking request fields and response models.
| Step | Endpoint | Use it to |
| --- | --- | --- |
| Receive webhooks | `POST /callback/` | Accept tracking updates from Starshipit at your configured endpoint. |
| Poll tracking | [GET /api/track](/developers/api-reference/starshipit#endpoint-tracking-get-api-track-tracking) | Reconcile tracking status when webhooks are unavailable or missed. |
| List printed shipments | [GET /api/orders/shipments?status=recently_printed](/developers/api-reference/starshipit#endpoint-orders-get-api-orders-shipments-status-recently-printed-list-orders-printed-or-unmanifested) | Find recently printed or unmanifested shipments. |
| List shipped orders | [GET /api/orders/shipped](/developers/api-reference/starshipit#endpoint-orders-get-api-orders-shipped-list-orders-shipped) | Reconcile source-system shipment status. |
## Expected receiver behaviour
1. Receive the webhook payload.
2. Validate the payload shape and required identifiers.
3. Validate the `X-Starshipit-Signature` header if you configured a secret.
4. Store the raw event or a normalised event record.
5. Return `200` as soon as the event is accepted for processing.
6. Process long-running source-system updates outside the request path.
7. Ignore duplicate events that have already been processed.
## Example payload
```json
{
"order_number": "API-TEST-1001",
"carrier_name": "Australia Post",
"carrier_service": "7B05",
"shipment_date": "2026-06-18T09:30:00Z",
"tracking_number": "TESTTRACK123",
"tracking_status": "Dispatched",
"last_updated_date": "2026-06-18T09:35:00Z"
}
```
## Design for retries and duplicates
Webhook receivers should be idempotent. Receiving the same event twice should not create duplicate fulfilment updates, duplicate emails, or duplicate source-system notes.
For both webhooks and polling, log:
- Event or request timestamp.
- Source order number.
- Starshipit order ID, if available.
- Tracking number.
- Carrier and service.
- Processing result.
Good idempotency keys include:
- A stored event ID if your receiver creates one.
- `order_number`, `tracking_number`, `tracking_status`, and `last_updated_date`.
- The source order ID plus the final tracking status your system stores.
## Failure handling
| Failure | Recommended handling |
| --- | --- |
| Receiver cannot parse JSON | Return a non-success response and log the raw body safely. |
| Source order cannot be found | Store the event for manual matching or scheduled reconciliation. |
| Source system is unavailable | Queue the event and retry from your own job processor. |
| Duplicate event | Return success and do not repeat downstream side effects. |
## Verify tracking updates
Create a test order, generate a label, and confirm the source system receives the tracking number and status you expect. Then resend or replay the same event to confirm duplicate handling works.
## Related guides
- [Webhook notifications](/articles/360000376436-webhook-notifications)
- [Starshipit API fundamentals](/articles/developer-center/starshipit-api/api-fundamentals)
- [Testing guidance](/articles/developer-center/getting-started/testing-guidance)
- [Starshipit API reference](/developers/api-reference/starshipit#tracking)
---
# API: How to create Tracking-Only orders
URL: https://support.starshipit.com/articles/8924419766927-api-how-to-create-tracking-only-orders
Canonical: https://support.starshipit.com/articles/8924419766927-api-how-to-create-tracking-only-orders
Markdown: https://support.starshipit.com/articles/8924419766927-api-how-to-create-tracking-only-orders.md
Updated: 2026-05-07
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Learn how to create tracking-only orders via the Starshipit API for shipments with labels generated outside Starshipit.
Tracking-Only orders let you manage shipments with labels created outside of Starshipit. By incorporating these external shipments using their tracking numbers, you can monitor them alongside your Starshipit-generated orders, report on delivery status, and receive webhook events for tracking updates.
## Example use cases
* For customers managing clients who create shipments directly with couriers, transitioning to a new system might pose significant challenges. Keep it simple by letting them stick to their current methods and then just add their orders to Starshipit later. This way, all shipments can be tracked in one place without changing how clients operate.
* If you've developed a native courier integration for label generation but seek to enhance it with tracking capabilities, leverage a single integration with the Starshipit API. This approach grants you comprehensive tracking functionalities, with the added benefit of outsourcing maintenance and updates to Starshipit, ensuring your system remains efficient and up-to-date.
## How it works
1. An order is created and its tracking number is generated outside of Starshipit.
2. The tracking number is sent to Starshipit via the API.
3. Starshipit creates the order in its system and marks it as shipped.
4. Starshipit will then monitor the order and update its system with any delivery status changes.
5. If using webhooks, a webhook event is triggered and sent to your configured system whenever there's a delivery update
## Set up
* Begin by deciding whether to use a separate dedicated account for tracking-only orders or to include them in your existing Starshipit account. Opting for a separate account might simplify reporting on these orders. If this is your choice, you'll need to [create a child account](/articles/360001575375).
* In the chosen account, make sure you have your [API key and subscription key](/articles/integrations/the-starshipit-api/how-to-find-your-starshipit-api-key) handy. These credentials are essential for interacting with the Starshipit API to create and manage your shipments.
* If you plan to utilize webhooks for real-time updates, ensure your webhook URL is configured according to our [webhook setup guide.](/articles/notifications-branded-tracking-rules-child-accounts/notifications/webhook-notifications)
## Creating tracking only orders
Tracking-only orders are exclusively created via the Starshipit API. This streamlined process requires minimal mandatory information, the carrier (specified through an enum value) and the tracking number, ensuring we can accurately track each order.
* Utilize the `/shipped` endpoint for creating tracking-only orders. Detailed guidance on this endpoint can be found in the [Starshipit API reference](/developers/api-reference/starshipit#endpoint-tracking-only-orders-post-api-orders-shipped-create-tracking-only-order).
* For improved tracking and reporting, consider including an order number and customer name, although these are not mandatory.
* The API supports creating up to 50 orders in a single request, streamlining the process for bulk shipments.
* Standard rate limits apply to ensure the API's reliability and performance. Plan your integration with these limits in mind to avoid disruptions.
---
# Filters
URL: https://support.starshipit.com/articles/14700000001024-filters
Canonical: https://support.starshipit.com/articles/14700000001024-filters
Markdown: https://support.starshipit.com/articles/14700000001024-filters.md
Updated: 2026-06-18
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Use Starshipit API filters to narrow order searches and list responses.
Use filters when an endpoint supports a filter query parameter and you need to narrow the records Starshipit returns. Filters are most useful for order searches, list views, and sync jobs that only need a specific subset of orders.
## Filter syntax
Starshipit filters use this pattern:
```text
Column:::Value
```
If you send more than one filter, keep each filter as a separate value if the endpoint supports repeated filter parameters. URL-encode spaces and special characters in query strings.
## Common filters
| Filter | Use when | Example |
| --- | --- | --- |
| `Order` | You know the source order number. | `Order:::1419` |
| `Name` | You need orders for a recipient name. | `Name:::John Smith` |
| `Address` | You need to check address validation state. | `Address:::valid` |
| `Country` | You need orders going to a specific country. | `Country:::Australia` |
| `SKU` | You need orders containing a product SKU. | `SKU:::MOBILE-CASE-BLK` |
## Request example
The exact parameter name depends on the endpoint. For endpoints that accept a `filter` parameter, a request can look like this:
```bash
curl --request GET \
--url 'https://api.starshipit.com/api/orders/search?filter=Order%3A%3A%3A1419' \
--header "StarShipIT-Api-Key: YOUR_API_KEY" \
--header "Ocp-Apim-Subscription-Key: YOUR_SUBSCRIPTION_KEY"
```
## Build reliable filtered syncs
Use filters with pagination so your integration requests a predictable set of records. Store the query values you used for each sync run so support teams can reproduce the same request later.
If an endpoint also supports date, status, page, or page size parameters, use those fields with filters instead of making broad requests and filtering everything in your own system.
## Related guides
- [Starshipit API fundamentals](/articles/developer-center/starshipit-api/api-fundamentals)
- [Import orders, print in Starshipit, and update the source system](/articles/developer-center/starshipit-api/import-orders-into-starshipit)
- [Starshipit API reference](/developers/api-reference/starshipit)
---
# Starshipit API reference guide
URL: https://support.starshipit.com/articles/14700000001009-starshipit-api-reference-guide
Canonical: https://support.starshipit.com/articles/14700000001009-starshipit-api-reference-guide
Markdown: https://support.starshipit.com/articles/14700000001009-starshipit-api-reference-guide.md
Updated: 2026-06-18
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Use the Starshipit API reference to find endpoint groups, request methods, models, and the workflow guide each group supports.
Use the Starshipit API reference when you need exact endpoint paths, request parameters, request bodies, response models, and example responses. Start with the workflow guide first, then use the [Starshipit API reference](/developers/api-reference/starshipit) to confirm the technical details.
## Endpoint groups
The current Starshipit API reference is organised into these groups:
| Group | What it supports |
| --- | --- |
| Orders | Create, update, search, list, archive, restore, merge, and assign orders. |
| Shipments | Create labels, print packing slips, create commercial invoices, clone shipments, and replace shipments. |
| Tracking | Retrieve tracking details and delivery updates. |
| Tracking-only orders | Register externally generated tracking numbers with Starshipit. |
| Rates | Retrieve courier rates from your Starshipit courier configuration. |
| Address book | Manage address book records used in Starshipit. |
| Manifests | Manifest shipments and retrieve manifest information. |
| Pickup | List booked pickups and book a carrier pickup. |
| Order Documents | Upload, list, preview, download, replace, and delete documents attached to an order. |
| Products | Sync Product Catalogue data such as SKU, dimensions, weight, and customs fields. |
| Tags | List user-defined tags and add or remove tags on an order. |
| Models | Shared request and response shapes used by endpoint groups. |
## Use reference pages with guides
| If you are building | Start with |
| --- | --- |
| Import orders, print in Starshipit, and update source system | [Import orders, print in Starshipit, and update the source system](/articles/developer-center/starshipit-api/import-orders-into-starshipit) |
| Import or update orders, then print outside Starshipit | [Print outside Starshipit and return tracking](/articles/developer-center/starshipit-api/print-outside-starshipit-and-return-tracking) |
| Checkout or live rates | [Get checkout and live rates](/articles/developer-center/starshipit-api/get-live-rates-at-checkout) |
| Print labels for orders imported by Starshipit | [Print labels for orders Starshipit imported](/articles/developer-center/starshipit-api/print-labels-for-orders-starshipit-imported) |
| Update orders before printing | [Update orders before printing](/articles/developer-center/starshipit-api/update-orders-before-printing) |
| Product sync | [Sync product data with Product Catalogue](/articles/developer-center/starshipit-api/sync-product-data-with-product-catalogue) |
| Tracking writeback | [Use webhooks and tracking updates](/articles/developer-center/starshipit-api/use-webhooks-and-tracking-updates) |
| Request failures | [Troubleshoot API integrations](/articles/developer-center/getting-started/troubleshooting-api-integrations) |
## What the reference is for
The [Starshipit API reference](/developers/api-reference/starshipit) helps you confirm exact endpoint paths, request fields, response examples, and shared models after you have chosen the workflow you want to build.
The reference is a customer-facing API reference, not a complete inventory of every controller route in the codebase. Internal, partner-specific, or unreleased routes should only be added after the endpoint contract is confirmed for public developer use.
---
# WMS API fundamentals
URL: https://support.starshipit.com/articles/14700000001022-wms-api-fundamentals
Canonical: https://support.starshipit.com/articles/14700000001022-wms-api-fundamentals
Markdown: https://support.starshipit.com/articles/14700000001022-wms-api-fundamentals.md
Updated: 2026-09-08
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Understand WMS API base URL, authentication header, retries, errors, and integration habits.
Use these fundamentals when you design an integration for the Starshipit WMS API. Starshipit WMS is an add-on to Starshipit for warehouse workflows such as jobs, products, inventory, locations, purchase orders, picking, packing, putaway, replenishment, stocktake, and stock movements.
If you are building shipping, labels, rates, manifests, tracking, core Starshipit webhooks, or Product Catalogue workflows, use [Starshipit API fundamentals](/articles/developer-center/starshipit-api/api-fundamentals) instead. For events sent from WMS to your endpoint, use [WMS outbound webhooks](/articles/14700000001025-wms-outbound-webhooks).
## Base URL and headers
Use the WMS API base URL:
```text
https://wms.starshipit.com
```
Every WMS request should include:
| Header | Value |
| --- | --- |
| `starshipit-api-key` | Your Starshipit API key for the WMS account. |
The API key identifies the WMS account. You do not assign endpoint permissions to the key.
Use the [WMS API reference](/developers/api-reference/wms) to confirm the exact request parameters and body for each endpoint.
## Request design
When you build a WMS integration:
1. Keep the WMS API client separate from any core Starshipit API client.
2. Log the endpoint path, method, response status, response body, and source-system identifier.
3. Store stable IDs returned by WMS endpoints so retries and follow-up actions target the same record.
4. Re-read records before high-impact actions when warehouse state may have changed.
5. Test with a small workflow before moving real warehouse volume.
## Pagination and filters
List endpoints can use query parameters such as page, limit, search, filters, or status fields. When you build sync jobs:
- Request bounded page sizes.
- Process each page before requesting the next page.
- Store the last successful sync time, cursor, or source-system checkpoint your workflow can rely on.
- Log the filter and pagination values used for each request.
## Duplicate protection
Design write actions so retries do not create duplicate warehouse work.
| Action | Duplicate protection |
| --- | --- |
| Create or update a product | Match by stable SKU or product ID before retrying. |
| Move or adjust stock | Store the source transaction ID and reconcile stock movement results. |
| Create a job or workflow action | Check the current job status before repeating the action. |
| Pick, pack, or replenish | Confirm the operation has not already progressed to the next warehouse state. |
## Error handling
Error bodies are endpoint-specific. Do not assume every response contains `code`, `details`, `timestamp`, or retry metadata. Missing authentication can return `400` or `401`; use the endpoint reference for the exact contract.
Handle these statuses explicitly:
| Status | Meaning | Integration response |
| --- | --- | --- |
| `400` | The request body or parameters are invalid. | Log the validation response and surface the record for correction. |
| `401` | Credentials are missing or incorrect. | Stop retries and check the `starshipit-api-key` header. |
| `403` | The request is not allowed for the WMS account. | Confirm the API key belongs to the correct WMS account. If it does, contact Starshipit support. |
| `404` | The endpoint or record was not found. | Confirm the base URL, path, and identifiers. |
| `409` | The requested action conflicts with the current warehouse state. | Re-read the record and decide whether to retry, skip, or send for manual review. |
| `422` | An endpoint-specific validation or business-rule check failed. | Check the endpoint contract and correct the reported problem before retrying. |
| `429` | The integration sent too many requests. | Queue the work and retry later with backoff. |
| `5xx` | WMS or an upstream dependency could not complete the request. | Retry cautiously and alert if failures continue. |
## Related guides
- [Authentication and access](/articles/developer-center/getting-started/authentication-and-access)
- [Testing guidance](/articles/developer-center/getting-started/testing-guidance)
- [Troubleshoot API integrations](/articles/developer-center/getting-started/troubleshooting-api-integrations)
- [WMS API reference guide](/articles/developer-center/starshipit-wms-api/wms-api-reference-guide)
---
# Quickstart: Authenticate and look up WMS inventory
URL: https://support.starshipit.com/articles/14700000001026-quickstart-authenticate-and-look-up-wms-inventory
Canonical: https://support.starshipit.com/articles/14700000001026-quickstart-authenticate-and-look-up-wms-inventory
Markdown: https://support.starshipit.com/articles/14700000001026-quickstart-authenticate-and-look-up-wms-inventory.md
Updated: 2026-09-08
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Authenticate with the WMS API, look up inventory, and work through paginated results.
Use this quickstart to authenticate with the Starshipit WMS API, find a product by SKU, and store the WMS IDs needed for later warehouse workflows.
## Before you begin
- Confirm your account uses the Starshipit WMS add-on.
- Get the Starshipit API key for the WMS account you want to access.
- Store the API key in a secret manager and keep it out of source code and logs.
- Choose a test product that already exists in that account.
WMS API requests use `https://wms.starshipit.com`. Do not send these requests to the core Starshipit API domain.
## Look up inventory
1. Replace `WIDGET-001` with the SKU you want to find.
2. Send a bounded inventory request with the `starshipit-api-key` header.
```bash
curl --request GET \
--url "https://wms.starshipit.com/api/inventory?viewMode=product&search=WIDGET-001&page=1&pageSize=25" \
--header "starshipit-api-key: YOUR_STARSHIPIT_API_KEY"
```
3. Confirm the response contains the expected product and pagination fields.
```json
{
"items": [
{
"id": "product-123",
"sku": "WIDGET-001",
"name": "Super Widget",
"trackingType": "NONE",
"allocationRule": "FIFO",
"quantityOnHand": 60,
"quantityIncoming": 10,
"quantityReserved": 5,
"quantityCommitted": 8,
"quantityAvailable": 52,
"inventories": [
{
"locationId": "loc-source-456",
"locationName": "A-01-01",
"quantityOnHand": 50
},
{
"locationId": "loc-target-789",
"locationName": "B-02-03",
"quantityOnHand": 10
}
],
"detailedInventories": [],
"reservedOrders": [],
"pendingOrders": []
}
],
"totalCount": 1,
"page": 1,
"pageSize": 25,
"totalPages": 1
}
```
4. Store `items[0].id` as the `productId` for later requests.
5. Store the relevant `locationId` values if your next workflow needs them.
6. Check `quantityAvailable`, not only `quantityOnHand`, before you plan a stock-consuming action.
The example IDs in this article are illustrative and will not work in your account. WMS endpoints use record IDs rather than SKUs, barcodes, product names, or location names for follow-up actions.
## Process every page
Inventory uses a 1-based `page` and a `pageSize` with a maximum of `100`.
1. Process every item in the current response.
2. Increment `page` by one.
3. Send the next request.
4. Stop after `page` reaches `totalPages`.
Do not assume one response contains every matching record. Log the search and pagination values with each request so you can resume a failed sync safely.
## Handle authentication and lookup errors
| Response | What to do |
| --- | --- |
| `400` | Add the missing header or correct the query. Do not retry the same request unchanged. |
| `401` | Stop the workflow and replace or correct the API key. |
| `403` | Confirm the API key belongs to the correct WMS account. If it does, contact Starshipit support. |
| `404` | Confirm the WMS domain and that the key belongs to a WMS account. |
| `429` | Queue the request and retry later with exponential backoff and jitter. |
| `5xx` or timeout | Retry the read with bounded backoff. Alert if failures continue. |
## Related guides
- [Move WMS stock safely](/articles/developer-center/starshipit-wms-api/quickstart-move-wms-stock-safely)
- [Create and receive a WMS purchase order](/articles/developer-center/starshipit-wms-api/quickstart-create-and-receive-wms-purchase-order)
- [WMS API fundamentals](/articles/developer-center/starshipit-wms-api/wms-api-fundamentals)
- [WMS API reference](/developers/api-reference/wms)
---
# Quickstart: Move WMS stock safely
URL: https://support.starshipit.com/articles/14700000001027-quickstart-move-wms-stock-safely
Canonical: https://support.starshipit.com/articles/14700000001027-quickstart-move-wms-stock-safely
Markdown: https://support.starshipit.com/articles/14700000001027-quickstart-move-wms-stock-safely.md
Updated: 2026-09-14
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Check available inventory, transfer WMS stock between locations, and verify the movement safely.
Use this quickstart to check available inventory, transfer a small quantity between two WMS locations, and verify both sides of the movement.
## Before you begin
- Complete [Authenticate and look up WMS inventory](/articles/developer-center/starshipit-wms-api/quickstart-authenticate-and-look-up-wms-inventory).
- Choose a test product and store its `productId`.
- Store the source and destination `locationId` values. Do not substitute location names.
- Start with a non-tracked product or check the required batch or serial fields in the [Create Stock Movement endpoint](/developers/api-reference/wms#post-api-stock-movement-create-stock-movement).
:::warning
A stock movement changes warehouse inventory. Start with a small quantity and verify the result before increasing volume.
:::
This example transfers five units from `A-01-01` to `B-02-03`. A positive `change` moves stock from `transferLocationId` to `locationId`.
## Check stock before the transfer
1. Read the product in location view immediately before the transfer.
```bash
curl --request GET \
--url "https://wms.starshipit.com/api/inventory?viewMode=location&search=WIDGET-001&page=1&pageSize=100" \
--header "starshipit-api-key: YOUR_STARSHIPIT_API_KEY"
```
2. Confirm the source has enough available stock and the source and destination IDs are different.
```json
{
"items": [
{
"id": "loc-source-456",
"name": "A-01-01",
"type": "PICK_FACE",
"totalQuantity": 50,
"productCount": 1,
"products": [
{
"id": "product-123",
"sku": "WIDGET-001",
"trackingType": "NONE",
"quantityOnHand": 50,
"quantityCommitted": 5,
"quantityAvailable": 45
}
]
},
{
"id": "loc-target-789",
"name": "B-02-03",
"type": "BULK_STORAGE",
"totalQuantity": 10,
"productCount": 1,
"products": [
{
"id": "product-123",
"sku": "WIDGET-001",
"trackingType": "NONE",
"quantityOnHand": 10,
"quantityCommitted": 0,
"quantityAvailable": 10
}
]
}
],
"totalCount": 2,
"page": 1,
"pageSize": 100,
"totalPages": 1
}
```
## Transfer the stock
1. Create a stable `reference` in your source system.
2. Send the transfer.
```bash
curl --request POST \
--url https://wms.starshipit.com/api/stock-movement \
--header "starshipit-api-key: YOUR_STARSHIPIT_API_KEY" \
--header "Content-Type: application/json" \
--data '{
"productId": "product-123",
"locationId": "loc-target-789",
"transferLocationId": "loc-source-456",
"change": 5,
"reason": "API stock transfer",
"reference": "ERP-TRANSFER-00042"
}'
```
If the transfer returns `409` with `code: PRODUCT_LOCATION_DECISION_REQUIRED`, it has not completed. Read `pairs`, then resubmit with `retirementDecisions: [{"productId": "product-123", "locationId": "loc-source-456", "willStoreAgain": true}]` using the returned IDs. Use `true` to retain the source Allowed SKU. Use `false` only when it should be removed; removing the last Allowed SKU makes the location unrestricted. For `PRODUCT_LOCATION_DECISION_STALE`, refresh the source state before retrying.
3. Store both movement IDs from the `201 Created` response.
```json
{
"removalResult": [
{
"stockMovement": {
"id": "movement-out-123",
"productId": "product-123",
"locationId": "loc-source-456",
"change": -5,
"reason": "API stock transfer (Transfer Out)",
"reference": "ERP-TRANSFER-00042",
"timestamp": "2026-07-20T01:15:00.000Z"
}
}
],
"additionResult": {
"stockMovement": {
"id": "movement-in-456",
"productId": "product-123",
"locationId": "loc-target-789",
"fromLocationId": "loc-source-456",
"change": 5,
"reason": "API stock transfer (Transfer In)",
"reference": "ERP-TRANSFER-00042",
"timestamp": "2026-07-20T01:15:01.000Z"
}
}
}
```
## Verify the transfer
1. Repeat the inventory request from the pre-transfer check.
2. Confirm the source quantity decreased by five and the destination quantity increased by five.
```json
{
"items": [
{
"id": "loc-source-456",
"name": "A-01-01",
"totalQuantity": 45,
"products": [
{
"id": "product-123",
"quantityOnHand": 45,
"quantityCommitted": 5,
"quantityAvailable": 40
}
]
},
{
"id": "loc-target-789",
"name": "B-02-03",
"totalQuantity": 15,
"products": [
{
"id": "product-123",
"quantityOnHand": 15,
"quantityCommitted": 0,
"quantityAvailable": 15
}
]
}
],
"totalCount": 2,
"page": 1,
"pageSize": 100,
"totalPages": 1
}
```
## Retry an uncertain transfer safely
The public WMS API reference does not document an idempotency key for stock movements. Do not automatically repeat a transfer after a timeout.
1. Search movement history with `GET /api/stock-movement?search=ERP-TRANSFER-00042&paginate=true&page=1&limit=50`.
2. Re-read inventory at both locations.
3. Retry only when you have confirmed the first request did not change stock.
Stock movement history returns pagination metadata when you set `paginate=true` or supply `page` or `limit`. `page` starts at `1`, `limit` has a maximum of `1000`, and `hasNext` tells you whether to request another page.
A `400` response means the movement data is invalid. For a `403`, confirm the API key belongs to the correct WMS account. If it does, contact Starshipit support. A `404` means a product or location ID was not found. For `409`, re-read inventory because the available stock may have changed.
## Related guides
- [Authenticate and look up WMS inventory](/articles/developer-center/starshipit-wms-api/quickstart-authenticate-and-look-up-wms-inventory)
- [WMS stock integrity and adjustments](/articles/starshipit-wms/returns/starshipit-wms-stock-integrity-and-adjustments)
- [WMS API fundamentals](/articles/developer-center/starshipit-wms-api/wms-api-fundamentals)
- [WMS API reference](/developers/api-reference/wms)
---
# WMS outbound webhooks
URL: https://support.starshipit.com/articles/14700000001025-wms-outbound-webhooks
Canonical: https://support.starshipit.com/articles/14700000001025-wms-outbound-webhooks
Markdown: https://support.starshipit.com/articles/14700000001025-wms-outbound-webhooks.md
Updated: 2026-07-27
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Configure and secure WMS outbound webhooks, verify signatures, and handle supported events, payloads, retries, and ordering.
Use Starshipit WMS outbound webhooks to send signed warehouse event notifications to your HTTPS endpoint and process them safely in your own system.
## Understand the webhook direction
This guide covers events sent **from Starshipit WMS to an endpoint you control**. You configure these outbound webhooks in WMS under **System > Settings > Webhooks**.
They are different from the order and shipment events that Starshipit sends into WMS. Those inbound events keep WMS synchronised with Starshipit and are configured through the Starshipit WMS integration.
## Before you begin
You need:
- Permission to manage WMS settings.
- One publicly reachable HTTPS endpoint.
- A shared secret that both WMS and your receiver can store securely.
- A receiver that can access the unmodified raw request body before parsing JSON.
- Durable storage for received webhook IDs so your integration can ignore duplicate deliveries.
:::important
Do not expose the webhook secret in client-side code, logs, or error messages. Generate a long, random value and store it in your server-side secret manager.
:::
## Configure outbound webhooks
1. Sign in to [Starshipit WMS](https://wms.starshipit.com).
2. Go to **System > Settings**.
3. Select **Webhooks**.
4. Enter your public HTTPS endpoint in **Webhook URL**.
5. Enter your shared signing secret in **Webhook secret**.
6. Enable the event groups your endpoint should receive.
7. Turn on **Enable webhooks**.
8. Select **Save changes**.
You must configure a URL, a secret, and at least one event group before you can enable webhooks. After a secret is saved, WMS does not display it again. Leave **Webhook secret** blank when saving later changes if you want to keep the stored secret.
WMS currently has no test-send action. To verify your setup, enable only the event group you want to test, perform a low-risk action with test data, and confirm the delivery in both your receiver logs and WMS monitoring.
## Meet the endpoint security requirements
WMS accepts a webhook URL only when it meets these rules:
- The URL uses `https://`.
- The URL uses a public, fully qualified hostname or a public IPv4 address. `localhost`, `.localhost`, `.local`, single-label hostnames, and IPv6 literal URLs are not accepted. A hostname can resolve to public IPv6 addresses.
- The URL does not contain a username or password.
- Every address returned for a hostname must pass WMS address checks. For IPv4, WMS blocks unspecified, private, loopback, carrier-grade NAT, link-local, benchmark, multicast, and reserved ranges. For IPv6, WMS blocks unspecified, loopback, unique-local, link-local, site-local, multicast, and mapped blocked IPv4 addresses.
- The endpoint returns a final response directly. WMS does not follow HTTP redirects.
WMS resolves the hostname again when it sends a request. A URL that was valid when saved can still be blocked at delivery time if its DNS records later resolve to a non-public address.
## Receive a webhook request
WMS sends an HTTP `POST` request with a UTF-8 JSON body. The body uses this envelope:
```json
{
"id": "inventory-changed:account-123:movement-456",
"event_type": "inventory_changed",
"occurred_at_utc": "2026-07-20T02:15:30.000Z",
"source": "starshipit-wms",
"account_id": "account-123",
"data": {
"stock_movement_id": "movement-456",
"product_id": "product-789",
"location_id": "location-101",
"from_location_id": null,
"inventory_id": "inventory-202",
"client_id": null,
"change": -2,
"reason": "Order shipped",
"reference": "order-1001",
"timestamp_utc": "2026-07-20T02:15:30.000Z",
"batch_number": null,
"serial_number": null,
"expiry_date_utc": null
}
}
```
| Envelope field | Type | Description |
| --- | --- | --- |
| `id` | string | Stable event ID. It stays the same across retries of the same event. |
| `event_type` | string | One of the supported event names in this guide. |
| `occurred_at_utc` | string | ISO 8601 timestamp for the event occurrence. |
| `source` | string | Always `starshipit-wms`. |
| `account_id` | string | WMS account ID that owns the event. |
| `data` | object | Event-specific payload. |
### Request headers
| Header | Value |
| --- | --- |
| `Content-Type` | `application/json` |
| `Content-Length` | Byte length of the UTF-8 request body. |
| `User-Agent` | `starshipit-wms` |
| `X-Starshipit-WMS-Webhook-Id` | Same value as body `id`. |
| `X-Starshipit-WMS-Webhook-Event` | Same value as body `event_type`. |
| `X-Starshipit-WMS-Timestamp` | Delivery timestamp used when calculating the signature. |
| `X-Starshipit-WMS-Signature` | `sha256=` followed by the lowercase hexadecimal HMAC digest. |
Header names are case-insensitive. After verifying the signature, confirm the ID and event headers match their corresponding body fields.
## Verify the signature
WMS signs the exact raw request body with HMAC-SHA256. It builds the signed value as:
```text
X-Starshipit-WMS-Timestamp + "." + raw_request_body
```
It then calculates the HMAC with your webhook secret and sends the hexadecimal result as:
```text
sha256=
```
Read the body as raw bytes or an unmodified UTF-8 string. Do not parse and re-serialise the JSON before verification. Whitespace, escaping, and property order affect the digest.
### Node.js verification example
```js
import { createHmac, timingSafeEqual } from "node:crypto";
export function verifyWmsWebhook({ secret, timestamp, rawBody, signature }) {
if (!timestamp || !/^sha256=[0-9a-f]{64}$/.test(signature ?? "")) {
return false;
}
const expected = createHmac("sha256", secret)
.update(`${timestamp}.${rawBody}`, "utf8")
.digest("hex");
const received = signature.slice("sha256=".length);
return timingSafeEqual(
Buffer.from(expected, "hex"),
Buffer.from(received, "hex"),
);
}
```
Call the function before `JSON.parse(rawBody)`. Pass the value of `X-Starshipit-WMS-Timestamp` as `timestamp` and `X-Starshipit-WMS-Signature` as `signature`.
### Python verification example
```python
import hashlib
import hmac
import re
def verify_wms_webhook(secret, timestamp, raw_body, signature):
if not timestamp or not re.fullmatch(r"sha256=[0-9a-f]{64}", signature or ""):
return False
signed_value = timestamp.encode("utf-8") + b"." + raw_body
expected = "sha256=" + hmac.new(
secret.encode("utf-8"),
signed_value,
hashlib.sha256,
).hexdigest()
return hmac.compare_digest(expected, signature)
```
Pass the original request body bytes as `raw_body`. Verify the signature before decoding or parsing the JSON.
For additional replay protection, validate that the delivery timestamp is a valid ISO 8601 timestamp and falls within a time window your service accepts. Use the stable event ID for deduplication; do not use the delivery timestamp as the deduplication key because it changes on each attempt.
## Acknowledge deliveries safely
WMS treats any `2xx` response as a successful delivery. Your endpoint has five seconds to respond.
Use this receiver pattern:
1. Read the raw request body.
2. Verify the HMAC signature with a constant-time comparison.
3. Validate the envelope and confirm the header ID and event match the body.
4. Atomically store the event ID and payload, or recognise that the ID was already stored.
5. Return a `2xx` response.
6. Process slower downstream work asynchronously.
Return a non-`2xx` response if you could not durably accept a valid event. WMS retries request errors, timeouts, status `408`, `425`, `429`, and `5xx` responses. Other `4xx` responses are terminal and are not retried.
## Handle retries, duplicates, and ordering
WMS uses at-least-once delivery. Your endpoint can receive the same event more than once, including when WMS sent the first request successfully but did not receive the response.
### Deduplicate by event ID
The body `id` and `X-Starshipit-WMS-Webhook-Id` stay stable across delivery attempts for the same event. Store this ID in a table with a unique constraint and make the event handler idempotent.
Treat the event ID as an opaque string. Its internal format can differ by event type and should not drive your business logic.
Do not deduplicate using `occurred_at_utc`, `X-Starshipit-WMS-Timestamp`, or a hash of the complete request. The delivery timestamp and signature change on every attempt.
### Delivery attempts and backoff
For a retryable failure, WMS makes up to five attempts in total. After a failed attempt, it schedules the next attempt with exponential backoff and bounded jitter:
| Failed attempt | Approximate delay before the next attempt |
| --- | --- |
| 1 | 1 minute, with ±25% jitter. |
| 2 | 2 minutes, with ±25% jitter. |
| 3 | 4 minutes, with ±25% jitter. |
| 4 | 8 minutes, with ±25% jitter. |
Retry delays are capped at 15 minutes. A retryable delivery moves to a terminal failed state after the fifth failed attempt. A non-retryable `4xx` response moves to a terminal failed state after its first attempt.
### Per-entity ordering
WMS preserves first-in, first-out processing within these delivery streams:
| Event family | Ordering stream |
| --- | --- |
| `job_created`, `job_status_changed` | WMS job ID. |
| Purchase order lifecycle events and `stock_received` | Purchase order ID. |
| Order lifecycle events | WMS order ID. |
| `inventory_changed` | Product ID and location ID pair. |
| `low_stock_alert` | Product ID. |
Events in different streams can be delivered concurrently. There is no account-wide or global ordering guarantee. Separate streams for the same product, such as `inventory_changed` and `low_stock_alert`, are not ordered relative to each other.
## Supported events
You enable related events as groups in WMS settings, but each request contains one exact event name.
| Event name | WMS setting | Sent when a covered WMS workflow records |
| --- | --- | --- |
| `low_stock_alert` | **Low stock alerts** | A product crosses from a non-urgent restocking state into urgent restocking status. |
| `stock_received` | **Stock received** | A purchase order receipt records a positive received quantity. |
| `inventory_changed` | **Inventory changed** | A stock movement is created. |
| `purchase_order_created` | **Purchase order lifecycle** | A purchase order is created. |
| `purchase_order_updated` | **Purchase order lifecycle** | A purchase order is updated without changing status. |
| `purchase_order_status_changed` | **Purchase order lifecycle** | A purchase order moves to a different status. |
| `purchase_order_deleted` | **Purchase order lifecycle** | A purchase order is deleted. |
| `job_created` | **Job created** | A WMS job is created. |
| `job_status_changed` | **Job status changed** | A WMS job moves to a different status. |
| `order_created` | **Order lifecycle** | A WMS order record is created. |
| `order_updated` | **Order lifecycle** | A covered WMS order update is recorded. |
| `order_status_changed` | **Order lifecycle** | A WMS order moves to a different status. |
| `order_deleted` | **Order lifecycle** | A WMS order is deleted or archived through a covered deletion workflow. |
:::important
Lifecycle webhooks are operational notifications, not a complete change-data-capture or audit feed. Some imports, synchronisations, bulk workflows, and administrative actions can change records without emitting an outbound lifecycle event. Build periodic API reconciliation for data that must be complete.
:::
## Event payload reference
The following tables describe the object inside the envelope `data` field. Fields described as nullable are present with `null` when no value is available. Fields described as optional can be omitted.
### `low_stock_alert`
| Field | Type | Description |
| --- | --- | --- |
| `product_id` | string | WMS product ID. |
| `product_name` | string | Product name. |
| `sku` | string | Product SKU. |
| `available_quantity` | integer | Stock quantity used by the alert calculation, rounded to a non-negative whole number. |
| `days_until_stockout` | number | Projected days until the product is out of stock. |
| `lead_time_days` | number | Product lead time in days. |
This event is emitted only when WMS detects a transition into urgent restocking status with a valid stockout projection and a positive lead time. It is not emitted repeatedly while the product remains urgent.
### `stock_received`
| Field | Type | Description |
| --- | --- | --- |
| `purchase_order_id` | string | WMS purchase order ID. |
| `purchase_order_number` | string | Purchase order number. |
| `supplier_name` | string | Supplier name. |
| `received_at_utc` | string | ISO 8601 receipt timestamp. |
| `total_quantity_received` | number | Total quantity received in this receiving action. |
| `line_items` | array | Items and locations included in this receiving action. |
Each `line_items` entry contains:
| Field | Type | Description |
| --- | --- | --- |
| `product_id` | string | WMS product ID. |
| `product_name` | string | Product name. |
| `sku` | string | Product SKU. |
| `location_id` | string | Destination WMS location ID. |
| `location_name` | string | Destination location name. |
| `quantity_received` | number | Quantity received for this product and location. |
### `inventory_changed`
| Field | Type | Description |
| --- | --- | --- |
| `stock_movement_id` | string | Stable WMS stock movement ID. |
| `product_id` | string | WMS product ID. |
| `location_id` | string | WMS location affected by the movement. |
| `from_location_id` | string or null | Source location for a transfer, when available. |
| `inventory_id` | string or null | Related WMS inventory record ID. |
| `client_id` | string or null | Related 3PL client ID. |
| `change` | number | Signed quantity change. Positive values add stock and negative values remove stock. |
| `reason` | string | WMS movement reason. |
| `reference` | string | WMS reference recorded for the movement. |
| `timestamp_utc` | string | ISO 8601 movement timestamp. |
| `batch_number` | string or null | Batch number for batch-tracked stock. |
| `serial_number` | string or null | Serial number for serial-tracked stock. |
| `expiry_date_utc` | string or null | ISO 8601 expiry date or timestamp for tracked stock. |
### Purchase order lifecycle events
The following events use the same `data` shape:
- `purchase_order_created`
- `purchase_order_updated`
- `purchase_order_status_changed`
- `purchase_order_deleted`
| Field | Type | Description |
| --- | --- | --- |
| `purchase_order_id` | string | WMS purchase order ID. |
| `purchase_order_number` | string | Purchase order number. |
| `supplier_id` | string or null | WMS supplier ID. |
| `supplier_name` | string or null | Supplier name. |
| `previous_status` | string or null | Previous status for a status change or deletion; otherwise `null`. |
| `status` | string | Current or last recorded purchase order status. |
| `created_date_utc` | string | ISO 8601 purchase order creation date. |
| `expected_arrival_date_utc` | string or null | ISO 8601 expected arrival date. |
| `cartons_received` | number or null | Number of cartons received. |
| `line_items` | array | Purchase order line items. |
Purchase order `status` values are `DRAFT`, `CREATED`, `PARTIALLY_RECEIVED`, and `RECEIVED`.
Each `line_items` entry contains:
| Field | Type | Description |
| --- | --- | --- |
| `line_item_id` | string or null | WMS purchase order line item ID. |
| `product_id` | string | WMS product ID. |
| `quantity` | number | Line quantity. |
| `quantity_ordered` | number or null | Quantity ordered. |
| `quantity_received` | number or null | Quantity received. |
| `price` | number or null | Line item price. |
### `job_created`
The `data` object contains the job fields below.
| Field | Type | Description |
| --- | --- | --- |
| `job_id` | string | WMS job ID. |
| `job_type` | string | WMS job type. |
| `status` | string | Current job status. |
| `priority` | number | Job priority. |
| `display_name` | string or null | Job display name. |
| `created_at_utc` | string | ISO 8601 creation timestamp. |
| `updated_at_utc` | string | ISO 8601 last update timestamp. |
| `started_at_utc` | string or null | ISO 8601 start timestamp. |
| `completed_at_utc` | string or null | ISO 8601 completion timestamp. |
| `paused_at_utc` | string or null | ISO 8601 pause timestamp. |
| `assigned_user_id` | string or null | Assigned WMS user ID. |
| `order_ids` | array, optional | Related WMS order IDs. |
| `purchase_order_id` | string or null | Related WMS purchase order ID. |
| `packing_location_id` | string or null | Related packing location ID. |
| `staging_location_id` | string or null | Related staging location ID. |
| `zone_id` | string or null | Related WMS zone ID. |
| `replenishment_product_id` | string or null | Product ID for a replenishment job. |
| `replenishment_location_id` | string or null | Location ID for a replenishment job. |
| `replenishment_quantity` | number or null | Quantity for a replenishment job. |
Job `job_type` values are `PICK`, `PACK`, `SHIP`, `PUTAWAY`, `REPLENISHMENT`, `KITTING`, and `CYCLE_COUNT`. Job `status` values are `PENDING`, `READY`, `ASSIGNED`, `IN_PROGRESS`, `PAUSED`, `COMPLETED`, and `FAILED`.
### `job_status_changed`
| Field | Type | Description |
| --- | --- | --- |
| `previous_status` | string or null | Status before the change. |
| `new_status` | string | Status after the change. |
| `job` | object | Complete job object using the `job_created` fields above. |
WMS does not send this event when a job update leaves the status unchanged. There are no separate `job_updated` or `job_deleted` outbound events.
### Order lifecycle events
The following events use the same `data` shape:
- `order_created`
- `order_updated`
- `order_status_changed`
- `order_deleted`
| Field | Type | Description |
| --- | --- | --- |
| `order_id` | string | WMS order ID. |
| `starshipit_order_id` | string | Related Starshipit order ID. |
| `order_number` | string | Customer-facing order number. |
| `reference` | string | Order reference. |
| `client_id` | string or null | Related 3PL client ID. |
| `account_id_override` | number or null | Starshipit account override value, when used. |
| `previous_status` | string or null | Status before a status change or deletion; otherwise `null`. |
| `status` | string | Current or last recorded WMS order status. |
| `delete_reason` | string or null | `order_deleted` or `order_archived` for a deletion event; otherwise `null`. |
| `order_date_utc` | string | ISO 8601 order date. |
| `created_at_utc` | string | ISO 8601 WMS record creation timestamp. |
| `updated_at_utc` | string | ISO 8601 WMS record update timestamp. |
| `line_items` | array, optional | WMS order line items when the emission path has loaded them. |
Order `status` values are `PENDING`, `RELEASED`, `PARTIALLY_SHIPPED`, `SHIPPED`, `CANCELLED`, and `RETURNED`.
Each `line_items` entry contains:
| Field | Type | Description |
| --- | --- | --- |
| `line_item_id` | string or null | WMS order line item ID. |
| `product_id` | string | WMS product ID. |
| `quantity` | number | Ordered quantity. |
## Monitor webhook delivery
Check both WMS and your receiver when you monitor the integration.
### Check queue activity
1. Open the WMS **Operations** dashboard.
2. Select **Background work**.
3. Find entries labelled **Webhook delivery**.
4. Review the status, attempt count, error, and next retry time.
A `completed` status means the configured endpoint returned a `2xx` response. A `dead letter` status means the endpoint returned a terminal response or all retry attempts failed.
### Check process logs
Go to **System > Process Logs** and filter for webhook activity. WMS records entries such as:
- `WMS webhook emitted: ` for successful delivery.
- `WMS webhook delivery failed: ` for a failed attempt.
- `WMS webhook not emitted: ` when an unexpected configuration or event condition prevents emission.
Process log details include the event ID, event type, occurrence time, destination hostname, and response status or failure reason where available. They do not expose the webhook secret.
### Log deliveries in your receiver
Record at least the event ID, event type, account ID, occurrence time, receive time, deduplication result, and downstream processing status. Do not log the shared secret or other sensitive data from your environment.
## Troubleshoot outbound webhooks
| Problem | What to check |
| --- | --- |
| No webhook is queued | Confirm webhooks and the correct event group are enabled. Confirm the action uses a covered emission path and meets event-specific conditions. |
| The URL cannot be saved | Use HTTPS with a public, fully qualified hostname and remove embedded credentials. |
| Delivery is blocked as a private address | Check every IPv4 and IPv6 address returned by public DNS. Remove private, local, loopback, link-local, or other non-public results. |
| Signature verification fails | Use the exact raw body and the delivery timestamp header. Do not parse, format, or re-serialise JSON first. Confirm both systems use the same secret. |
| The endpoint receives duplicates | Deduplicate atomically on the stable event ID and make downstream handlers idempotent. |
| Deliveries time out | Durably accept the event and return `2xx` within five seconds. Move slow work to your own queue. |
| Events appear out of order | Compare their ordering streams. Ordering is per entity stream, not global across an account or between different event families. |
| A delivery reached `dead letter` | Fix the endpoint, then reconcile the affected data through the WMS API. Customer self-service replay is not available. |
## Current limitations
- You can configure one outbound webhook endpoint per WMS account.
- WMS does not provide a test-send action.
- Customers cannot replay a delivery from WMS.
- The external webhook envelope has no `schema_version` field or schema-version header.
- Lifecycle webhooks do not cover every possible mutation path and are not a complete audit feed.
- WMS provides per-entity ordering, not global event ordering.
Because the external envelope has no schema version, ignore unknown fields and avoid rejecting a valid event only because WMS added a field you do not use.
## Related guides
- [WMS API guide](/articles/developer-center/starshipit-wms-api/wms-api-guide)
- [WMS API fundamentals](/articles/developer-center/starshipit-wms-api/wms-api-fundamentals)
- [WMS Settings reference](/articles/14700000000031-starshipit-wms-settings-reference)
- [Running WMS alongside Starshipit](/articles/14700000000004-starshipit-wms-working-alongside-starshipit-hybrid-outbound-headless-mode)
---
# Quickstart: Create and receive a WMS purchase order
URL: https://support.starshipit.com/articles/14700000001028-quickstart-create-and-receive-a-wms-purchase-order
Canonical: https://support.starshipit.com/articles/14700000001028-quickstart-create-and-receive-a-wms-purchase-order
Markdown: https://support.starshipit.com/articles/14700000001028-quickstart-create-and-receive-a-wms-purchase-order.md
Updated: 2026-09-08
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Create a WMS purchase order, receive its stock, and verify the completed receiving workflow.
Use this quickstart to find a supplier, create a WMS purchase order, receive one line, and verify the final purchase-order state.
## Before you begin
- Complete [Authenticate and look up WMS inventory](/articles/developer-center/starshipit-wms-api/quickstart-authenticate-and-look-up-wms-inventory).
- Choose a test product and store its `productId`.
- Choose a receiving location and store its `locationId`.
- Use a test account or test records before you receive live warehouse inventory.
- Enable cartons received in the account receiving settings before using the example with `cartonsReceived: 1`. Otherwise omit that field and expect `cartonsReceived: 0` when verifying the purchase order.
- Check the account over-receiving limit and under-receiving tolerance before receiving or completing the purchase order.
:::warning
Receiving a purchase order changes warehouse inventory and can create putaway work. Start with one line and a small quantity.
:::
## Find the supplier
1. Retrieve suppliers.
```bash
curl --request GET \
--url https://wms.starshipit.com/api/supplier \
--header "starshipit-api-key: YOUR_STARSHIPIT_API_KEY"
```
2. Match the supplier in your source system, then store its `id`. Do not substitute the supplier name.
```json
[
{
"id": "supplier-456",
"name": "ACME Widget Supply Co."
}
]
```
## Create the purchase order
1. Use a purchase order number that is unique within the WMS account.
2. Send the create request.
```bash
curl --request POST \
--url https://wms.starshipit.com/api/purchase-order \
--header "starshipit-api-key: YOUR_STARSHIPIT_API_KEY" \
--header "Content-Type: application/json" \
--data '{
"poNumber": "ERP-PO-10042",
"supplierId": "supplier-456",
"status": "CREATED",
"total": 125,
"expectedArrivalDate": "2026-07-25",
"lineItems": [
{
"productId": "product-123",
"quantity": 10,
"price": 12.5
}
]
}'
```
3. Store the top-level purchase order `id` and each returned line item `id` from the `201 Created` response.
```json
{
"id": "po-def789",
"poNumber": "ERP-PO-10042",
"supplierId": "supplier-456",
"accountId": "account-123",
"createdDate": "2026-07-20T01:30:00.000Z",
"status": "CREATED",
"expectedArrivalDate": "2026-07-25T00:00:00.000Z",
"cartonsReceived": 0,
"supplier": {
"id": "supplier-456",
"accountId": "account-123",
"name": "ACME Widget Supply Co."
},
"lineItems": [
{
"id": "line-789",
"purchaseOrderId": "po-def789",
"productId": "product-123",
"quantity": 10,
"price": 12.5,
"quantityOrdered": null,
"quantityReceived": 0,
"quantityReceiving": null
}
]
}
```
`purchaseOrderId` is the top-level `id`. `lineItemId` is the `id` inside `lineItems`. Do not use the purchase order number, product ID, or SKU in place of either ID.
## Receive the purchase order
1. Read `GET /api/purchase-order/po-def789` and calculate the quantity that remains to receive.
2. Confirm the `targetLocationId` exists and allows the product.
3. Send the receiving request. Use a non-negative whole number in `quantityReceiving` for this transaction. Completion must satisfy the configured under-receiving tolerance for every line.
```bash
curl --request POST \
--url https://wms.starshipit.com/api/purchase-order/receive \
--header "starshipit-api-key: YOUR_STARSHIPIT_API_KEY" \
--header "Content-Type: application/json" \
--data '{
"purchaseOrderId": "po-def789",
"receivingItems": [
{
"lineItemId": "line-789",
"productId": "product-123",
"quantityReceiving": 10,
"targetLocationId": "loc-target-789"
}
],
"cartonsReceived": 1,
"markPOComplete": false
}'
```
4. Check both the HTTP status and the JSON `success` value.
```json
{
"success": true,
"message": "Receiving completed successfully! Items received directly to final locations.",
"stagingItemsCount": 0,
"crossDockItemsCount": 0,
"directItemsCount": 1,
"workflowMode": "direct"
}
```
The result depends on the target location and account receiving workflow. A staging location can create putaway work instead of adding stock directly to its final location.
Batch-tracked products require `batchNumber`. Serial-tracked products require one unique value in `serialNumbers` for each unit in `quantityReceiving`.
## Verify receiving
1. Retrieve the purchase order again.
```bash
curl --request GET \
--url https://wms.starshipit.com/api/purchase-order/po-def789 \
--header "starshipit-api-key: YOUR_STARSHIPIT_API_KEY"
```
2. Confirm `quantityReceived`, `status`, and `cartonsReceived` match the completed work.
```json
{
"accountId": "account-123",
"id": "po-def789",
"poNumber": "ERP-PO-10042",
"createdDate": "2026-07-20T01:30:00.000Z",
"expectedArrivalDate": "2026-07-25T00:00:00.000Z",
"status": "RECEIVED",
"cartonsReceived": 1,
"supplier": {
"id": "supplier-456",
"name": "ACME Widget Supply Co."
},
"lineItems": [
{
"id": "line-789",
"productId": "product-123",
"quantity": 10,
"price": 12.5,
"quantityReceived": 10,
"quantityOrdered": 0,
"quantityReceiving": 0,
"product": {
"id": "product-123",
"sku": "WIDGET-001",
"name": "Super Widget",
"trackingType": "NONE"
}
}
]
}
```
## Retry uncertain writes safely
The public WMS API reference does not document a general idempotency key for these writes.
- If creation times out, call `GET /api/purchase-order?search=ERP-PO-10042&limit=10` and match the exact `poNumber` before retrying. WMS rejects a duplicate purchase order number.
- If receiving times out, retrieve the purchase order and compare `quantityReceived` with the value from before the request. Do not send the same quantity again when the first request may have succeeded.
- A receiving workflow failure returns HTTP `422` with `"success": false`, `error`, and `message`. Correct the reported problem, including any receiving tolerance violation, before retrying.
`GET /api/purchase-order` supports `limit`, but does not return page metadata. Narrow list requests with `status` or `search`, and do not treat `limit` as a paginated cursor.
A `400` response means the payload is invalid. For a `403`, confirm the API key belongs to the correct WMS account. If it does, contact Starshipit support. A `404` means an account or record ID was not found. Reconcile current state before retrying a `5xx` response or timeout.
## Related guides
- [Authenticate and look up WMS inventory](/articles/developer-center/starshipit-wms-api/quickstart-authenticate-and-look-up-wms-inventory)
- [WMS suppliers and purchase orders](/articles/starshipit-wms/inbound/starshipit-wms-suppliers-and-purchase-orders)
- [WMS receiving stock](/articles/starshipit-wms/inbound/starshipit-wms-receiving-stock)
- [WMS API reference](/developers/api-reference/wms)
---
# Quickstart: Retrieve and manage WMS jobs
URL: https://support.starshipit.com/articles/14700000001029-quickstart-retrieve-and-manage-wms-jobs
Canonical: https://support.starshipit.com/articles/14700000001029-quickstart-retrieve-and-manage-wms-jobs
Markdown: https://support.starshipit.com/articles/14700000001029-quickstart-retrieve-and-manage-wms-jobs.md
Updated: 2026-09-08
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Retrieve paginated WMS jobs, update a job safely, and verify its current state.
Use this quickstart to retrieve ready picking jobs, read one job before changing it, update its priority, and verify the current state.
## Before you begin
- Get the Starshipit API key for the WMS account you want to access.
- Choose a test job that warehouse staff are not actively processing.
- Replace every example ID below with an ID returned by your WMS account.
## Retrieve a page of jobs
1. Request a bounded page of ready picking jobs.
```bash
curl --request GET \
--url "https://wms.starshipit.com/api/job?status=READY&type=PICK&page=1&limit=25&sortBy=createdAt&sortDirection=asc" \
--header "starshipit-api-key: YOUR_STARSHIPIT_API_KEY"
```
2. Store the job `id` and pagination fields.
```json
{
"success": true,
"jobs": [
{
"id": "job-abc123",
"type": "PICK",
"status": "READY",
"priority": 4,
"displayName": "Pick SO-1001",
"assignedUserId": null,
"packingLocationId": "loc-pack-1",
"createdAt": "2026-07-20T01:45:00.000Z"
}
],
"pagination": {
"page": 1,
"limit": 25,
"totalCount": 42,
"totalPages": 2,
"hasNext": true,
"hasPrev": false
}
}
```
`jobId` is the job `id`, not its display name or related order number.
Jobs use a 1-based `pagination.page` and a `pagination.limit` with a maximum of `100`. Process the current page, increment the `page` query parameter while `pagination.hasNext` is `true`, and stop when it becomes `false`. You can also compare `pagination.page` with `pagination.totalPages`.
## Read the job before changing it
1. Retrieve the job by ID immediately before you make a change.
```bash
curl --request GET \
--url https://wms.starshipit.com/api/job/job-abc123 \
--header "starshipit-api-key: YOUR_STARSHIPIT_API_KEY"
```
2. Confirm the job is still in a state your workflow can manage.
```json
{
"success": true,
"job": {
"id": "job-abc123",
"type": "PICK",
"status": "READY",
"priority": 4,
"assignedUserId": null,
"displayName": "Pick SO-1001"
}
}
```
## Update and verify the job
1. Send only the field you intend to change. Priority must be a whole number from `0` to `10`.
```bash
curl --request PATCH \
--url https://wms.starshipit.com/api/job/job-abc123 \
--header "starshipit-api-key: YOUR_STARSHIPIT_API_KEY" \
--header "Content-Type: application/json" \
--data '{
"priority": 7
}'
```
2. Confirm the update response.
```json
{
"success": true,
"job": {
"id": "job-abc123",
"status": "READY",
"assignedUserId": null,
"priority": 7
}
}
```
3. Repeat `GET /api/job/job-abc123` and confirm the new priority.
```json
{
"success": true,
"job": {
"id": "job-abc123",
"type": "PICK",
"status": "READY",
"priority": 7,
"assignedUserId": null,
"displayName": "Pick SO-1001"
}
}
```
Use the dedicated public pause and resume endpoints for paused-state transitions. Do not set `status` to `PAUSED`, or resume a paused job, through `PATCH /api/job/[id]`. See the [Jobs endpoints](/developers/api-reference/wms#jobs) for assignment, pause, resume, allocation, and expanded job-detail operations.
## Handle retries and conflicts
If an update times out, retrieve the job before retrying. Skip the retry when the job already has the requested value.
| Response | What to do |
| --- | --- |
| `400` | Correct the status, priority, assignment value, or request body. |
| `403` | Confirm the API key belongs to the correct WMS account. If it does, contact Starshipit support. |
| `404` | Confirm the `jobId` and WMS account. |
| `409` | Re-read the job because its status or assignment changed. Skip it or send it for manual review. |
| `429` | Queue the request and retry later with exponential backoff and jitter. |
| `5xx` or timeout | Re-read the job before deciding whether to retry the update. |
The public WMS API reference does not document a general idempotency key for job writes. Compare current state with your intended state before every retry.
## Related guides
- [WMS mobile jobs](/articles/starshipit-wms/mobile-app/starshipit-wms-mobile-jobs)
- [WMS API fundamentals](/articles/developer-center/starshipit-wms-api/wms-api-fundamentals)
- [WMS API reference guide](/articles/developer-center/starshipit-wms-api/wms-api-reference-guide)
- [WMS API reference](/developers/api-reference/wms)
---
# WMS API reference guide
URL: https://support.starshipit.com/articles/14700000001023-wms-api-reference-guide
Canonical: https://support.starshipit.com/articles/14700000001023-wms-api-reference-guide
Markdown: https://support.starshipit.com/articles/14700000001023-wms-api-reference-guide.md
Updated: 2026-09-14
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Use the WMS API reference to find endpoint groups, methods, request parameters, examples, and errors.
Use the WMS API reference when you need exact WMS endpoint paths, request parameters, request bodies, response examples, and error details. Start with the WMS guide first, then use the [WMS API reference](/developers/api-reference/wms) to confirm technical details.
## Endpoint groups
The WMS API reference is organised into these groups:
| Group | What it supports |
| --- | --- |
| Authentication | Required WMS API authentication header. |
| Jobs | Warehouse job lists, details, updates, assignment, safe close behavior, allocation, pause, and resume workflows. |
| Locations | Warehouse location lists, active or archived filtering, name, barcode, and zone search, creation, lookup, updates to location types and settings, and occupancy-aware responses. |
| Packages | Package lists and creation. |
| Products | WMS product lists, active or archived filtering, source stores, SKU lookup, creation, updates, deletion, and supported product syncs. |
| Suppliers | Supplier lists, creation, lookup, and updates for purchase and receiving workflows. |
| Purchase orders | Purchase order lists, creation, duplication, lookup, updates, email, receiving, restocking drafts, and mark-received actions. |
| Inventory | Inventory summaries, product detail, and batch, serial, or availability validation. |
| Stock movements | Stock movement lists, creation, transfers, and exports. |
| Allocations | Allocation lists and manual allocation deletion. |
| Picking | Pick job details, begin, pick, stage, and tote workflows. |
| Packing | Pack job details, progress, packages, carrier service, begin, and label-printing workflows. |
| Kitting | Kit job creation, detail, allocation, and processing. |
| Replenishment | Replenishment demand review, generation, manual creation, lines, pick, placement, and combination. |
| Putaway | Putaway lists, processing, eligibility checks, and cancellation. |
| Stocktake | Stocktake count submission, pending approval and submission history, and approval or decline before asynchronous inventory processing. |
| Analytics | Date-specific performance, staff activity filters, and operational reports, including backlog aging, slotting utilization, shipping economics, declared value vs COGS, replenishment jobs, and stock-movement summaries or detail CSV exports. |
| Error handling | Common error response patterns. |
## What the reference is for
The [WMS API reference](/developers/api-reference/wms) helps you confirm exact endpoint paths, request parameters, request bodies, response examples, and error details after you have chosen the warehouse workflow you want to build.
Create and manage orders through the [Starshipit API reference](/developers/api-reference/starshipit). Orders available in Starshipit enter WMS for warehouse processing, so WMS order endpoints are not included in the public WMS API reference.
The reference is a customer-facing API reference, not a complete promise that every internal WMS route is public for all accounts. Add or revise endpoints only when the customer-facing contract is confirmed.
## Related guides
- [WMS API guide](/articles/developer-center/starshipit-wms-api/wms-api-guide)
- [WMS API fundamentals](/articles/developer-center/starshipit-wms-api/wms-api-fundamentals)
- [WMS API reference](/developers/api-reference/wms)
---
# Where's my parcel?
URL: https://support.starshipit.com/articles/9171330231951-wheres-my-parcel
Canonical: https://support.starshipit.com/articles/9171330231951-wheres-my-parcel
Markdown: https://support.starshipit.com/articles/9171330231951-wheres-my-parcel.md
Updated: 2026-05-07
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Find out who to contact when you are waiting for a parcel from a retailer that uses Starshipit.
Starshipit is shipping software used by retailers. We are not the retailer that sold your order or the courier delivering it, and our support team cannot access your purchase or parcel details.
## Find your parcel
1. Check the order confirmation or dispatch email from the retailer for a tracking number and courier name.
2. Enter the tracking number on the courier's tracking website.
3. Contact the retailer if you do not have a tracking number or do not know which courier is delivering the parcel.
4. Contact the courier if tracking has stopped updating or the parcel is delayed after dispatch.
:::important
Please do not send order numbers, addresses, or other personal information to Starshipit Support. Contact the retailer or courier directly so they can investigate your delivery.
:::
Learn more about [what Starshipit does](/articles/getting-started/intro-to-starshipit/what-is-starshipit).
---
# Starshipit app: Troubleshooting
URL: https://support.starshipit.com/articles/9656290318735-starshipit-app-troubleshooting
Canonical: https://support.starshipit.com/articles/9656290318735-starshipit-app-troubleshooting
Markdown: https://support.starshipit.com/articles/9656290318735-starshipit-app-troubleshooting.md
Updated: 2026-05-07
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Troubleshooting steps for common issues like slowness or freezing in the Starshipit app.
This article provides troubleshooting steps for common issues, such as slowness or freezing, that may arise while using the Starshipit app. These steps will help narrow down the source of the problem and determine whether it is an issue locally or with the Starshipit app.
## Troubleshooting steps
We recommend following these steps to troubleshoot and determine whether the issue lies with your device or Starshipit.
1. **Replicate the issue on another device**
Use the Starshipit app on a different device. This will help identify if the issue is specific to your current device.
2. **Use another browser**
If you are experiencing problems with Starshipit, try accessing it using a different web browser. For example, if you are currently using Google Chrome, switch to Mozilla Firefox or Microsoft Edge. This will help determine if the issue is browser-related.
3. **Clear cache and cookies**
Clearing your browser's cache and cookies can often resolve various issues. These temporary files can sometimes interfere with the proper functioning of websites. Please refer to your browser's settings to find the option to clear cache and cookies.
4. **Use an incognito window**
Open a new incognito or private browsing window in your web browser and access the Starshipit app. This mode disables browser extensions and uses default settings, which can help identify if any extensions or settings are causing conflicts.
5. **Connect to a different network**
Connect your device to a different network, such as a mobile hotspot or a different Wi-Fi network. If the issue continues, it is less likely to be related to your network connection.
If your issue persists, please submit a ticket [here](https://help.starshipit.com) and let our support team know that you have already attempted the troubleshooting steps outlined above.
To provide better assistance, please also include screenshots or recordings related to the issue you are facing. This will help our support team understand the problem and provide a prompt solution.
---
# Download TeamViewer
URL: https://support.starshipit.com/articles/360000560216-download-teamviewer
Canonical: https://support.starshipit.com/articles/360000560216-download-teamviewer
Markdown: https://support.starshipit.com/articles/360000560216-download-teamviewer.md
Updated: 2026-05-07
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Download TeamViewer to give the Starshipit support team remote access to your computer for troubleshooting.
## How it works
TeamViewer is the world's number one software used for Internet-based remote access and support.
In some cases, our support team may need remote access to your computer so that we can troubleshoot and resolve your issue quickly. Our support agent can communicate to you via the TeamViewer chat function.
TeamViewer is very safe and does not pose any danger to your computer. For more information, see TeamViewer's [Security Statement.](https://dl.tvcdn.de/docs/en/TeamViewer-Security-Statement-en.pdf)
## Download TeamViewer
To give us remote access to your computer, [download TeamViewer](https://www.teamviewer.com/en/download/windows/). To connect to your computer, you'll need to send us your TeamViewer ID and Password. You can find this in TeamViewer:
---
# Troubleshooting: Orders not updating platform (writeback)
URL: https://support.starshipit.com/articles/6125898969487-troubleshooting-orders-not-updating-platform-writeback
Canonical: https://support.starshipit.com/articles/6125898969487-troubleshooting-orders-not-updating-platform-writeback
Markdown: https://support.starshipit.com/articles/6125898969487-troubleshooting-orders-not-updating-platform-writeback.md
Updated: 2026-05-07
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Troubleshoot why orders are not updating in your source system with tracking information after generating shipping labels.
This guide aims to help you find out why your orders are not updated in your system with tracking information and marking the orders as fulfilled/shipped after you generate your shipping labels. In Starshipit, we call this process of updating the source orders "Writeback".
## How does writeback work?
Writeback works by Starshipit using your marketplaces API to send back the correct tracking information based on the label you generated in Starshipit. You can configure writeback to happen either when you print your labels, or when you manifest them. To configure this, in Starshipit, navigate to:
**Settings** > **Integrations** > Tick or Untick **Write back order updates on manifest (otherwise it occurs on printing of labels)**
:::note
Not sure what writeback option to choose?
- **Unticking** Write back order updates on manifest will mean your orders will update the source system as soon as you generate a label in Starshipit. This is a good option to select if you wish to notify customers quickly that the label has been printed. This means that if you need to replace/redo the label after you have printed the order, you will need to manually update the order in your platform with the new tracking.
- **Ticking** Write back order updates on manifest will mean your orders will be updated after you manifest them in Starshipit. This option is good if you do not want to notify customers immediately upon generating a label and instead delay until you're ready to send the order.
:::
## Troubleshooting
If you have noticed some orders have not updated your source system correctly, see below for steps on how to resolve them.
### Initial Checks
* If you have your account configured to write back on manifest, ensure all orders have been manifested and are not archived.
### Retrying the writeback
Starshipit will automatically retry the writeback on your account for all failed orders every 2 hours. If you would like to retry this sooner, you can trigger the writeback manually using the below steps:
**Retrying writeback for a single order**
1. Search for the order and open it.
2. Retry the writeback:
In the top right, select the **More actions** menu and choose **Writeback to source**. Refresh the page and check to see if writeback has been updated to "Up to Date" on the top of the page.
Under **Source**, click on **Update**.
**For multiple orders**
1. Go to the printed/shipped tab.
2. Identify orders that have failed to writeback by looking for the red exclamation mark in the Writeback column.
3. Select the orders.
4. Select **Writeback to source** from the dynamic menu at the top.
1. Go to the printed/shipped tab.
2. Filter the orders by typing **Failed** in the filter field.
3. Select the orders.
4. Right-click > Select **Update selected orders (in source system)**.
### Finding the error
If you're still having trouble, you will need to locate the error causing the order to not writeback. To do this:
1. Search for the order that did not writeback.
2. Open the order and scroll to the order history section of the order at the bottom of the page.
Find the error in the history section like below.
Find a log that says "Writeback to [Platform]" and click on it to expand the error message.
### Viewing all orders with writeback issues
You can also view all orders that have writeback issues directly from the Orders grid.
In both Classic UI and UI 2.0:
1. From the Orders grid, use the filter to filter by writeback status.
2. Select 'Error' to display all orders where a writeback issue has occurred.
This allows you to quickly identify and review all affected orders without opening each one individually.
### Common Errors
Once you have found the error, see our list below of suggestions on how to resolve them.
| Error | Solution |
| --- | --- |
| API Limit | If you see any errors around API limits, this means that the source system prevented us from writing back due to too many API calls. You can retry the request by using the [above section](#h_01GNDV95YJTQF3DT9PG6TEQY23). Shopify: Shopify has a [REST admin API rate limit](https://shopify.dev/docs/api/admin-rest/usage/rate-limits). The maximum number of requests that can be made is dependent on your Shopify plan. |
| 403 Unauthorised | Any errors regarding being unauthorised mean that Starshipit does not have access to update the orders in your source system. Go through the relevant set-up guide for the integration and ensure that the user you have set up has Read and Write Permissions |
| Location Not Found | Shopify: This error occurs when the location you have specified in Settings > Integrations > Shopify Settings > Fulfilment Location doesn't exist anymore. Update this to the correct location and then [retry the writeback](#h_01GNDV95YJTQF3DT9PG6TEQY23) |
| Stock Error | The writeback will automatically mark the order as fulfilled. If you get an error related to stock, your source system has likely run out of the item in the order, and as such won't let us update the status. Ensure you have enough stock in the source system and then [retry the writeback](#h_01GNDV95YJTQF3DT9PG6TEQY23) |
| Already Fulfilled/Packed/Authorised | Starshipit can only writeback to unfulfilled, unshipped orders. If you get an error about the status of the order, make sure that the order in your source system is in the correct status to allow us to mark the order as fulfilled and send back the tracking |
| [Carrier Name] Does not exist | Some platforms (i.e. Cin7 Omni/Unleashed) require you to set up carriers within the platform for the writeback to work. Check out their set-up guides and ensure you have followed the required steps for mapping the carrier service |
| Writeback not required | If the order says writeback is not required, you may have accidentally disabled writeback. You can go to Settings > Integrations > Integration Settings and check if you haven't ticked or unticked settings related to writeback. |
| Could not save a shipment, see the error log for details | This error from Magento 2 requires you to [check the logs](https://experienceleague.adobe.com/en/docs/commerce-on-cloud/user-guide/develop/test/log-locations) in Magento to find out the error. Please note that multi-source inventory is not supported with Magento and often the cause of this error |
| The fulfilment order has been completed or closed | This error is from Shopify and can mean a few things. Typically it is that the order has already been fulfilled. It may also mean that the order has a 3rd party platform as the fulfilment service which will not allow Starshipit to writeback |
| Items already shipped | This generally means that the order has already been updated and the items have been marked as shipped. Please check your platform to see if these were manually updated. |
| Using PeopleVox? | When using Peoplevox, Starshipit will only update PeopleVox with the tracking details, it will not update your original eCommerce Platform (Shopify, Magento, BigCommerce etc) with the tracking details. If you're having trouble with this, this indicates an issue with your connection between PeopleVox and the eCommerce platform. Peoplevox will be able to assist with identifying the root cause. |
If your error is not listed here, please contact our support team [here](https://help.starshipit.com).
---
# Troubleshooting: Orders not importing
URL: https://support.starshipit.com/articles/360001575455-troubleshooting-orders-not-importing
Canonical: https://support.starshipit.com/articles/360001575455-troubleshooting-orders-not-importing
Markdown: https://support.starshipit.com/articles/360001575455-troubleshooting-orders-not-importing.md
Updated: 2026-05-07
> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).
> Troubleshoot why orders are not displaying in Starshipit, including connection issues, import settings, and missing data.
This guide aims to help you find out why your orders are not displaying in Starshipit.
The most common reasons for not being able to find your order(s) are:
* The order was already processed/archived - use search all to find missing orders.
* The order was not imported - mainly because the status didn't match, or because a rule prevented it from being imported.
## All orders are not importing
If all orders from your platform have stopped importing, the connection between Starshipit and your platform has likely been broken. This means we are not able to connect to the platform to retrieve orders. Follow the steps below to troubleshoot:
1. To auto-import your orders, go to **Settings** > **Integrations** > **Automatically Import orders**.
2. Go to **Settings** > **Integrations** > **[Integration Name]** > **Test**. If you get an error here, we recommend starting over with the [integration guide](/categories/integrations) and re-integrating the platform. It may be that the user to integrate the account has been removed or had its password changed.
3. If applicable: Ensure you have whitelisted [Starshipit's IPs](/articles/integrations/accounting-other-platforms/list-of-ip-addresses-that-require-access-to-your-platform) from your servers.
This is not required for Shopify.
4. If the test succeeded, try to run a [manual import](/articles/orders-manifests-reports/orders/import-orders) for 30 days.
## Some orders are not importing
If specific orders are not imported, it is likely related to the order, or the configuration of your account.
1. If a single order is not importing, navigate to [Classic UI](https://app.starshipit.com/) > Open the affected order > **Save Order**.
2. By default, Starshipit's auto import task runs every 20 minutes and will look at the last 2 days' worth of orders. If your order is older than that, navigate to **Logs** > **Verbose Logs** and activate logging for 15 minutes or 1 hour. Then run a [manual import](/articles/orders-manifests-reports/orders/import-orders) to bring the orders in. This is common for back-ordered/pre-ordered shipments where it takes some time before you are ready to process the order. Make sure to check the Verbose Logs and filter by order number to verify the issue. For Shopify, webhooks can send eligible updates in near real time, but the scheduled import cycle is still used as a fallback. Shopify imports any order updated since the last auto import started.
3. If you're having trouble with Shopify orders, navigate to **Settings** > **Integrations** > **Shopify Settings** > **Troubleshooting import** tab and follow the steps in the page.
4. Check your account to ensure nothing could be preventing them from coming in:
* Go to **Settings** > **Rules** and ensure you do not have any rules where the action is Import Orders or Do Not Ship and the condition meets the order you are trying to import. A good way to see if this is causing the issue is to remove the rule and try import and see if that helps.
* With Shopify and TradeGecko, you can configure the integration to block orders with specific tags. If the order you are trying to import has a tag, go to **Settings** > **[Integration Name]** > and check to see if the tag is in the list of exclusions
* With each platform, in **Settings** > **[Integration Name]** > **Status to Import,** you can specify what status orders should be in to be allowed to import into Starshipit. Make sure that the status you have configured here matches the status of the order in your platform.
* Ensure that the order number you have doesn't already exist in Starshipit
5. Check the order in your eCommerce platform for the following things:
* Does the order have a shipping address?
* Do the items in the order require shipping (Shopify)?
* Is the order unfulfilled/open?
6. Advanced: With an order number that isn't importing, you can go to **Settings** > **Integrations** > **[Integration Name]** > **Tools/Advanced/Troubleshooting** and find a tool for **Check Order Details**. If you enter the order number here, you can pull up the API information for that order and see if the status matches what you have set in Starshipit for import.
1. Use the tool to compare:
* An order that successfully imports.
* An order that does not import.
2. Look for differences such as:
* Incorrect JSON syntax.
* HTML included in product descriptions.
* Any data formatting inconsistencies.
* For example, HTML in item descriptions may prevent an order from importing correctly.
## Imported orders are missing data
If you notice that some of the orders you imported are missing items or tags, you can resolve this issue by [removing and then re-importing them](/articles/orders-manifests-reports/faqs/how-to-remove-re-import-orders). This process will help to ensure that all the necessary information and tags are properly included with each order. By removing and re-importing the orders, you have the opportunity to check the data and resolve any missing item or tag issues that may have occurred during the initial import.
## Need more help?
If none of these suggestions solves your issue, please contact our [support team](https://help.starshipit.com) with the following information:
* Verbose log entries.
* Order IDs for affected and unaffected orders.
* Any recent changes made to your integration or rules.
---