> ## Documentation Index
> Fetch the complete documentation index at: https://help.kivaro.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Complete Setup Guide

> Comprehensive guide to configuring and using all features of the AusPost MyPost Business app

export const calendlyUrl = "https://calendly.com/kivaro-support/30min";

export const supportEmail = "support@kivaro.io";

export const companyName = "Kivaro";

export const auspostPartnersUrl = "https://auspost.com.au/mypost-business/account-management/partners";

export const shopifyAppStoreUrl = "https://apps.shopify.com/auspost-mypost-business";

export const appName = "AusPost MyPost Business";

## Complete Setup Guide

This comprehensive guide covers everything you need to know about setting up and using the {appName} app. If you're just getting started, we recommend beginning with our [Quick Start guide](/quickstart) for a streamlined setup process.

The {appName} app streamlines your shipping process by integrating directly with Australia Post's MyPost Business platform. Create shipping labels instantly, manage bulk operations, and automate your fulfillment workflow - all from within your Shopify admin.

## What You'll Get

<CardGroup cols={2}>
  <Card title="Instant Label Generation" icon="shipping-fast">
    Create shipping labels instantly for individual orders or bulk operations
  </Card>

  <Card title="Flexible Packaging" icon="box">
    Choose from Australia Post flat-rate packaging or create custom packages
  </Card>

  <Card title="Bulk Operations" icon="list">
    Generate multiple shipping labels at once for efficient order fulfillment
  </Card>

  <Card title="Packing Slips" icon="file">
    Generate professional packing slips with order details for your shipments
  </Card>

  <Card title="Split Shipments" icon="truck">
    Divide orders into multiple shipments for items in different locations or with different fulfillment needs
  </Card>

  <Card title="Smart Shipping Rules" icon="gear">
    Automate package selection and shipping options based on order conditions
  </Card>

  <Card title="Partial Fulfillments" icon="truck">
    Handle partial order fulfillments with ease and accuracy
  </Card>

  <Card title="Multiple Locations" icon="map-pin">
    Manage shipping from multiple warehouse locations seamlessly
  </Card>

  <Card title="International Shipping" icon="globe">
    Handle customs declarations and export documentation for global orders
  </Card>

  <Card title="Tracking Page" icon="location-dot" href="/getting-started#tracking-page">
    Monitor all shipments with real-time tracking updates and event timelines (Paid plans only)
  </Card>

  <Card title="Tracking Alerts" icon="bell" href="/tracking-alerts">
    Automated alerts for shipment issues and delays (Paid plans only)
  </Card>
</CardGroup>

## Prerequisites

Before you begin, make sure you have:

1. **Active Shopify Store** - Your store must be live and accessible
2. **Australia Post MyPost Business Account** - You'll need an active account with Australia Post
3. **Valid Payment Method** - Either a credit/debit card or business credit account with Australia Post

<Note>
  **Don't have a MyPost Business account?** You can sign up for a free account at <a href="https://auspost.com.au/business/shipping/mypost-business" target="_blank" rel="noopener noreferrer">auspost.com.au/business/shipping/mypost-business</a>. With a free MyPost Business account, you can save up to 40% on domestic shipping and up to 35% on international shipping as your shipping volume grows.
</Note>

## Installation

### Step 1: Install the App

<AccordionGroup>
  <Accordion icon="download" title="Add from Shopify App Store">
    1. Visit the <a href={shopifyAppStoreUrl}>Shopify App Store</a> and search for "
       {appName}" 2. Click **Install** and follow the installation prompts 3. Grant
       the required permissions when prompted

    <Warning>
      The app requires access to orders, products, and fulfillment data to
      generate accurate shipping labels.
    </Warning>
  </Accordion>
</AccordionGroup>

### Step 2: Connect Your Australia Post Account

<AccordionGroup>
  <Accordion icon="key" title="Get Your Merchant Token">
    Retrieve your unique merchant token from Australia Post: 1. Log in to your
    <a href={auspostPartnersUrl}>Australia Post MyPost Business account</a> 2. Navigate
    to "eCommerce Partners" and find "{companyName}"

    <Frame>
      <img src="https://mintcdn.com/kivaro/7kE8Fd-5C3MGM8r_/images/auspost-partners-page.png?fit=max&auto=format&n=7kE8Fd-5C3MGM8r_&q=85&s=2e4a51a334a58d26e85e5acd0293cac7" alt="Australia Post eCommerce Partners page showing Kivaro integration" style={{ borderRadius: "0.5rem" }} width="1428" height="202" data-path="images/auspost-partners-page.png" />
    </Frame>

    3. Click **Connect** and ensure you have a payment method added to your account
    4. Copy the generated merchant token

    <Frame>
      <img src="https://mintcdn.com/kivaro/7kE8Fd-5C3MGM8r_/images/auspost-connect-kivaro.png?fit=max&auto=format&n=7kE8Fd-5C3MGM8r_&q=85&s=1135612e0677eafaa4bd0543133f7c80" alt="Australia Post Kivaro connection page with merchant token" style={{ borderRadius: "0.5rem" }} width="1422" height="210" data-path="images/auspost-connect-kivaro.png" />
    </Frame>

    <Tip>Your merchant token is unique to your Australia Post account and should be kept secure.</Tip>
  </Accordion>

  <Accordion icon="link" title="Configure in Shopify">
    Connect your account in the Shopify app: 1. Open the {appName}
    app in your Shopify admin 2. Click **Connect MyPost Business Account** 3.
    Paste your merchant token 4. Select your preferred payment method 5. If
    using a business credit account, enter your account number 6. Click **Save**

    <Tip>
      If you need to regenerate your token, you can do so from your Australia
      Post account settings.
    </Tip>
  </Accordion>
</AccordionGroup>

## Basic Setup

### Configure Default Settings

<AccordionGroup>
  <Accordion icon="print" title="Label Preferences">
    Set up your default printing and label preferences: - Choose your default
    print layout (A4 or A6) - Select label format based on your printer setup -
    Configure international shipping preferences (A4 only)

    <Tip>
      **Thermal Label Printing:** If you're using a thermal label printer, select **A6** as your print layout option. A6 format is specifically designed for thermal printers and ensures optimal label quality and compatibility with standard thermal label sizes.
    </Tip>
  </Accordion>

  <Accordion icon="shipping-fast" title="Postage Options">
    Configure your default shipping services and options: - Set default shipping
    services (Parcel Post, Express Post) - Configure signature on delivery
    preferences - Set up transit cover options for valuable items

    <Tip>
      These settings help streamline the label creation process for most orders.
    </Tip>
  </Accordion>

  <Accordion icon="box" title="Package Options">
    Set up your packaging preferences: - Choose from Australia Post flat-rate
    packaging - Create custom packages for your specific needs - Set default
    package for automatic selection

    <Tip>
      Custom packages help optimize shipping costs and ensure proper fit for
      your products.
    </Tip>
  </Accordion>

  <Accordion icon="map-pin" title="Return Address">
    Configure your return address for shipping labels:

    <Tip>
      **Important:** By default, the return address on your shipping labels will be your fulfillment location address. Before generating labels, please verify this address is correct. You can customize the return address for each location from the app settings page if needed.
    </Tip>

    * Review your fulfillment location addresses
    * Configure custom return addresses if using multiple warehouses or 3PL providers
    * Ensure return addresses are accurate for customer returns
  </Accordion>
</AccordionGroup>

### Create Your First Shipping Label

<AccordionGroup>
  <Accordion icon="shipping-fast" title="From Order Details">
    Create labels for individual orders: 1. Navigate to any unfulfilled order in
    your Shopify admin 2. Click **Create shipping label** in the order details
    3\. Review and adjust package details if needed 4. Select shipping service
    and options 5. Click **Buy shipping label**

    <Warning>
      Before generating labels, verify that the return address (which defaults to your fulfillment location address) is correct. You can change it from the app settings page if needed.
    </Warning>

    <Tip>
      Labels are automatically applied to orders and tracking information is
      sent to customers.
    </Tip>
  </Accordion>

  <Accordion icon="list" title="Bulk Label Creation">
    Process multiple orders at once: 1. Go to **Orders** in your Shopify admin
    2\. Select multiple unfulfilled orders 3. Click **Create shipping labels**
    from the bulk actions 4. Review all orders and make adjustments as needed 5.
    Click **Buy shipping labels** to process all at once

    <Tip>
      Bulk operations are perfect for high-volume stores or batch processing.
    </Tip>
  </Accordion>

  <Accordion icon="link" title="Admin Actions Integration">
    Use the "Create Shipping Labels" admin action for seamless integration:

    1. **Orders Listing Page**: Select one or more orders and click **More actions** → **Create Shipping Labels**
    2. **Order Details Page**: Click **More actions** → **Create Shipping Labels** for a single order

    This sends orders directly to the Kivaro MyPost Business App where you can purchase shipping labels, fulfill orders, and notify customers with tracking details — all in one place.

    <Tip>
      The admin action provides a streamlined workflow that keeps you in your Shopify admin while accessing all shipping functionality.
    </Tip>
  </Accordion>
</AccordionGroup>

## Key Features

### Shipping Rules

Automate your shipping process with intelligent rules:

<Steps>
  <Step title="Create a Rule">
    Navigate to **Shipping Rules** in the app and click **Add Rule**
  </Step>

  <Step title="Set Conditions">
    Define when the rule applies (order weight, value, customer location, etc.)
  </Step>

  <Step title="Configure Actions">
    Specify what happens when conditions are met (package selection, shipping service,
    signature requirements, Extra Cover, etc.)
  </Step>

  <Step title="Activate">
    Enable the rule to start automating your shipping decisions
  </Step>
</Steps>

### Package Management

<AccordionGroup>
  <Accordion title="Flat-Rate Packaging">
    Use Australia Post's pre-defined satchels and boxes: - **Satchels**: Extra
    Small, Small, Medium, Large, Extra Large (max 5kg) - **Boxes**: Various
    sizes with weight limits - Automatic pricing based on Australia Post rates
  </Accordion>

  <Accordion title="Custom Packages">
    Create your own package definitions: - Define dimensions (length, width,
    height) - Set weight limits - Choose package type (box or satchel) - Set as
    default for automatic selection
  </Accordion>
</AccordionGroup>

### International Shipping

For international orders, the app supports:

* **Customs Declarations**: Automatic HS code management
* **Export Documentation**: EDN (Export Declaration Number) handling
* **Country-Specific Rules**: Different requirements per destination
* **Value-Based Processing**: Automatic declaration requirements

<Warning>
  International shipping labels can only be printed on A4 paper due to their
  size requirements.
</Warning>

## Usage Tracking

Monitor your app usage with built-in analytics:

* **Monthly Label Count**: Track labels generated each month
* **Usage Limits**: Monitor against your plan limits
* **Recent Activity**: View daily and weekly label generation
* **Transaction History**: Detailed cost breakdown with GST

## Tracking Page

<Note>
  **Paid Plans Only**: The Tracking Page feature is available exclusively for Growth and Scale plan subscribers. Starter plan users must upgrade to access this feature.
</Note>

Monitor all your shipments in one centralized location with the Tracking Page. This powerful feature provides real-time visibility into your order fulfillment status, helping you stay informed about every package in transit.

### Key Features

<CardGroup cols={2}>
  <Card title="Real-Time Updates" icon="sync">
    Tracking information is automatically updated throughout the day
  </Card>

  <Card title="Status Tracking" icon="check-circle">
    Monitor shipments with "In Transit" and "Delivered" status tabs
  </Card>

  <Card title="Event Timeline" icon="clock">
    View detailed event history for each shipment with location and timestamps
  </Card>

  <Card title="Transit Time" icon="truck">
    See estimated transit times and track delivery progress
  </Card>
</CardGroup>

### What You Can Track

The Tracking Page displays comprehensive information for each shipment:

* **Order Information**: Direct links to Shopify orders
* **Tracking Numbers**: Copy tracking numbers with one click
* **Last Checkpoint**: Most recent tracking event location and status
* **Transit Time**: Days in transit from order date
* **Order Date**: When the order was placed
* **Destination**: Delivery address with postcode
* **Current Status**: Real-time shipment status (In Transit, Delivered, etc.)

### Using the Tracking Page

<Steps>
  <Step title="Access Tracking">
    Navigate to the **Tracking** page in your {appName} app
  </Step>

  <Step title="View Shipments">
    Browse all shipments organized by status using the "In Transit" and "Delivered" tabs
  </Step>

  <Step title="Expand Details">
    Click on any shipment row to view the complete event timeline with location details and timestamps
  </Step>

  <Step title="Copy Tracking Numbers">
    Click the copy icon next to any tracking number to quickly copy it to your clipboard
  </Step>

  <Step title="View External Tracking">
    Click the external link icon to view detailed tracking on Australia Post's website
  </Step>
</Steps>

### Automatic Updates

Tracking events are automatically synchronized throughout the day to keep you informed about your shipments. The system:

* **Updates Status**: Automatically refreshes tracking information for active shipments
* **Stops at Terminal Status**: Ceases updates when packages reach terminal statuses (Delivered, Cancelled, Cannot be delivered)
* **Time Zone Aware**: Displays all dates and times in your configured timezone
* **Event History**: Maintains a complete timeline of all tracking events for each shipment

### Plan Availability

<Warning>
  **Upgrade Required**: The Tracking Page is only available for paid plans (Growth and Scale). Starter plan users will see an upgrade prompt when accessing this feature.
</Warning>

**Available Plans:**

* ✅ **Growth Plan**: Full access to Tracking Page
* ✅ **Scale Plan**: Full access to Tracking Page
* ❌ **Starter Plan**: Not available (upgrade required)

**Want to try this feature?** Upgrade to our paid plan which includes a 14-day trial period. This gives you full access to the Tracking Page and all premium features risk-free.

## Tracking Alerts

<Note>
  **Paid Plans Only**: The Tracking Alerts feature is available exclusively for Growth and Scale plan subscribers. Starter plan users must upgrade to access this feature.
</Note>

Get a complete **birds-eye view** of all your shipments and proactively intervene when issues arise. Tracking Alerts automatically monitors every package and alerts you the moment action is needed—whether that's contacting Australia Post, reaching out to customers, or investigating delivery problems.

### Business Value

* **Complete Visibility**: See all shipment issues across your entire operation in one dashboard
* **Proactive Intervention**: Know exactly when to contact Australia Post or customers before problems escalate
* **Time Savings**: Eliminate manual tracking checks—the system monitors everything automatically
* **Cost Reduction**: Catch lost or delayed packages early to minimize refunds and reshipments
* **Customer Service Excellence**: Address issues before customers contact you, improving satisfaction and retention

### Key Benefits

* **Birds-Eye View**: Daily email summaries and dashboard show all issues in one place
* **Proactive Operations**: Know when to contact Australia Post vs. when to reach out to customers
* **Automated Monitoring**: System continuously monitors all shipments—no manual checking required
* **Actionable Intelligence**: Each alert includes suggested actions and all details needed to take action

### Alert Types

The system supports seven different alert types:

* **No Update for X Days**: Alerts when packages haven't received tracking updates
* **Awaiting Collection for X Days**: Notifies when packages wait for customer collection
* **Returned to Sender**: Immediate notification when packages are returned
* **Label Not Lodged for X Days**: Identifies labels created but never lodged with carrier
* **Possible Delay**: Alerts when carrier indicates possible delivery delays
* **Article Damaged**: Immediate notification when packages are damaged
* **Cannot Be Delivered**: Alerts when packages cannot be delivered to address

### Email Notifications

Configure email notifications to receive daily summary emails with all active alerts:

* **Daily Summaries**: One email per day with all active alerts
* **Categorized Alerts**: Alerts grouped by type for easy scanning
* **Complete Details**: Each alert includes tracking number, order, status, and description
* **Multiple Recipients**: Add up to 3 email addresses per shop

### Getting Started with Alerts

<Steps>
  <Step title="Access Alert Settings">
    Navigate to **Alerts** → **Alert Settings** in your {appName} app
  </Step>

  <Step title="Enable Alerts">
    Check the "Enable this alert" checkbox for each alert type you want to monitor
  </Step>

  <Step title="Configure Thresholds">
    Set business day thresholds for time-based alerts (No Update, Awaiting Collection, Label Not Lodged)
  </Step>

  <Step title="Set Up Email Notifications">
    Enable email notifications and add recipient email addresses (up to 3)
  </Step>
</Steps>

<Tip>
  **Email Delivery**: Add `tracking-notifications@kivaro.io` to your safe sender list to ensure email alerts aren't filtered to spam.
</Tip>

For complete documentation on Tracking Alerts, including detailed configuration instructions and troubleshooting, see our [Tracking Alerts guide](/tracking-alerts).

## Other Paid Plan Features

In addition to the Tracking Page and Tracking Alerts, paid plans (Growth and Scale) include access to:

* **Shopify Flow Automation**: Automate shipping label generation with workflow triggers (see [Shopify Flow guide](/shopify-flow))
* **Pickup Scheduling**: Schedule Australia Post pickups directly from the app
* **Label Branding**: Customize shipping labels with your branding

<Note>
  For detailed information about Shopify Flow automation, see our [Shopify Flow guide](/shopify-flow). For complete Tracking Alerts documentation, see our [Tracking Alerts guide](/tracking-alerts). Pickup scheduling and label branding features are available in the app settings for paid plan subscribers.
</Note>

## Troubleshooting

### Common Issues

<AccordionGroup>
  <Accordion title="Invalid Merchant Token">
    **Problem**: App shows "Invalid merchant token" error **Solution**: - Verify
    your token is correctly copied from Australia Post - Check if your Australia
    Post account is active - Regenerate the token if needed
  </Accordion>

  {" "}

  <Accordion title="Payment Method Issues">
    **Problem**: Labels fail to generate due to payment issues **Solution**: -
    Ensure your Australia Post account has sufficient credit - Verify your payment
    method is valid and active - Check business credit account number if using
    that option
  </Accordion>

  <Accordion title="Label Generation Fails">
    **Problem**: Labels are not being created successfully **Solution**: -
    Verify order has a valid shipping address - Check that items are not already
    fulfilled - Ensure package weight doesn't exceed limits - Review
    international shipping requirements if applicable
  </Accordion>

  <Accordion title="Refunding Shipping Labels">
    **Need to refund a label?** Currently, Australia Post does not provide a way to refund labels through their API. To refund a shipping label purchased through the app:

    1. Log in to your [Australia Post MyPost Business account](\{auspostPartnersUrl})
    2. Navigate to the **Transactions** tab
    3. Click **View** for the label batch you want to refund
    4. Click **View** again for the specific label you want to refund
    5. Click the red **Refund** button

    <Note>
      If the refund is successful, the charges will be returned to your credit card or PayPal account within 5–10 business days.
    </Note>
  </Accordion>
</AccordionGroup>

## Support

Need help? We're here to assist:

<CardGroup cols={2}>
  <Card title="Book Free Consultation" icon="calendar" href={calendlyUrl}>
    Schedule a one-on-one session with our experts
  </Card>

  <Card title="Contact Support" icon="envelope" href={`mailto:${supportEmail}`}>
    Get help with setup, configuration, or troubleshooting
  </Card>
</CardGroup>

## Advanced Features

### Custom Location Addresses

Perfect for merchants using multiple warehouses, 3PLs, or PO Boxes. Configure custom "From / Return" addresses for each fulfillment location.

<Card title="Location Address Configuration" icon="warehouse">
  Set up custom addresses for each fulfillment location in your settings. Use your fulfillment location address by default, or override with custom addresses for specific locations.
</Card>

**Benefits:**

* **Multi-warehouse Support**: Different addresses for different warehouses
* **3PL Integration**: Custom addresses for third-party logistics providers
* **PO Box Support**: Use PO Box addresses for specific locations
* **Flexible Configuration**: Mix default and custom addresses as needed

### Per-Order Shipment Configuration

Customize delivery instructions and customer references for individual orders, giving you complete control over each shipment.

<Card title="Order-Level Customization" icon="cog">
  Access shipment settings for each order by clicking the settings icon in the shipping labels page to customize delivery instructions, customer references, and other shipment-specific details.
</Card>

**Features:**

* **Custom Delivery Instructions**: Add specific instructions for each order (uses Shopify delivery instructions by default)
* **Customer References**: Set unique reference numbers per order
* **Order-Specific Settings**: Override default settings when needed
* **Bulk Configuration**: Apply settings to multiple orders at once

### Bulk Delivery Instructions

Efficiently add delivery instructions to multiple orders simultaneously, perfect for seasonal campaigns or special handling requirements.

<Card title="Bulk Instructions" icon="list">
  Apply delivery instructions to multiple orders at once, streamlining your fulfillment process for special campaigns or handling requirements.
</Card>

**Use Cases:**

* **Seasonal Campaigns**: "Handle with care - Holiday gift"
* **Special Handling**: "Fragile - Extra protection required"
* **Delivery Preferences**: "Leave at front door if no answer"
* **Customer Instructions**: "Call before delivery"

## Next Steps

Now that you're set up, explore these advanced features:

* [Shipping Rules Configuration](/shipping-rules) - Automate your shipping decisions
* [Bulk Operations Guide](/bulk-operations) - Efficiently process multiple orders
* [International Shipping](/international-shipping) - Handle global orders
* [Package Management](/package-management) - Optimize your packaging strategy

<Note>
  The app integrates seamlessly with your existing Shopify workflow. All
  generated labels automatically update order fulfillment status and send
  tracking information to customers.
</Note>
