> ## Documentation Index
> Fetch the complete documentation index at: https://www.zippendo.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# How-to guides

> Field-level Zippendo how-tos — every screen, modal, and control, from picking a service point to API tokens and webhooks.

These how-tos are **one task or one screen** in the Zippendo client ([app.zippendo.com](https://app.zippendo.com)). Each page is meant to rank for a search like “Zippendo service point” or “Zippendo API token”: every visible field, every option, validation, and empty state.

They are not the [platform tutorials](/docs/tutorials). Tutorials are click-through journeys (first shipment, connect Shopify). How-tos zoom into the controls on those journeys. Use a how-to when you are already on the screen and need the meaning of a toggle, dropdown, or error.

<Frame caption="Open Settings from Manage in the team switcher — it is not a sidebar item">
  <img src="https://mintcdn.com/zippendo/nCpImT05qv67zgRn/images/screenshots/dashboard-light.png?fit=max&auto=format&n=nCpImT05qv67zgRn&q=85&s=0445593b99b7218a08c1ff649307ab94" alt="Zippendo dashboard with fulfilment overview, orders, and shipments" className="block dark:hidden" width="2880" height="1800" data-path="images/screenshots/dashboard-light.png" />

  <img src="https://mintcdn.com/zippendo/nCpImT05qv67zgRn/images/screenshots/dashboard-dark.png?fit=max&auto=format&n=nCpImT05qv67zgRn&q=85&s=1f0b192b5634d9b0ce9561bd51ce42ec" alt="Zippendo dashboard with fulfilment overview, orders, and shipments" className="hidden dark:block" width="2880" height="1800" data-path="images/screenshots/dashboard-dark.png" />
</Frame>

## How-tos vs tutorials

| You want                                      | Open                                           |
| --------------------------------------------- | ---------------------------------------------- |
| A guided path with screenshots of each click  | [Tutorials](/docs/tutorials)                        |
| What this field, toggle, or empty state means | **How-to** (this tab)                          |
| Status dictionaries and product reference     | [Documentation](/docs/introduction)                 |
| Something already broken                      | [Knowledge base](/docs/knowledge-base/introduction) |
| REST, SDKs, MCP                               | [API Reference](/docs/api-reference/overview)       |

<Tip>
  Start from the journey if you are new: [Getting started](/docs/tutorials/getting-started), then [Create a shipment](/docs/tutorials/create-a-shipment). Jump here when a form or Settings tab needs a field-by-field answer.
</Tip>

## Connect

Every merchant-connectable carrier, event app, and order channel — one line of credentials each. Per-connector pages live in the **Connect a carrier** and **Connect an integration** nav groups.

<CardGroup cols={2}>
  <Card title="Connect a carrier or integration" icon="plug" href="/docs/how-to/connect-index">
    Inventory of All Carriers, Integrations catalog, and order channels — Connect vs Request.
  </Card>

  <Card title="Connect an integration" icon="blocks" href="/docs/how-to/connect-an-integration">
    Slack, Klaviyo, Customer.io, Mailchimp, SendGrid, Zapier, Make — the Integrations screen.
  </Card>

  <Card title="Carrier credentials" icon="key" href="/docs/how-to/carrier-credentials">
    Shared connect/edit/delete chrome for every carrier form.
  </Card>

  <Card title="Request a carrier" icon="git-pull-request" href="/docs/how-to/request-carrier-integration">
    Submit a carrier that is not on All Carriers.
  </Card>
</CardGroup>

## Shipments

<CardGroup cols={2}>
  <Card title="Send a shipment" icon="send" href="/docs/how-to/send-a-shipment">
    Book a pending shipment with the carrier — required parties, product, and send vs retry.
  </Card>

  <Card title="Pick a service point" icon="map-pin" href="/docs/how-to/pick-a-service-point">
    Choose a nearby droppoint when the product delivers to a service point.
  </Card>

  <Card title="Split and move parcels" icon="split" href="/docs/how-to/split-and-move-parcels">
    Split a draft into more parcels or move a package onto a sibling shipment.
  </Card>

  <Card title="Customs and documents" icon="file-text" href="/docs/how-to/customs-and-documents">
    Incoterms, invoice toggles, CN22/CN23, and document types on a shipment.
  </Card>

  <Card title="Inbound and returns" icon="undo-2" href="/docs/how-to/inbound-and-returns">
    Inbound type, return parties, and auto-create return from a shipping rule.
  </Card>

  <Card title="Shipment parties" icon="users" href="/docs/how-to/shipment-parties">
    Sender, receiver, billing, freight payer, pickup, return — required address fields.
  </Card>

  <Card title="Hold, cancel, or delete" icon="ban" href="/docs/how-to/hold-cancel-and-delete-shipments">
    Delete a pending row from the list. On Hold and Cancelled are statuses from automations — not detail buttons.
  </Card>

  <Card title="Apply a shipping rule" icon="route" href="/docs/how-to/apply-a-shipping-rule">
    Assign a rule on an order or shipment so carrier and product fill in.
  </Card>
</CardGroup>

## Orders and channels

<CardGroup cols={2}>
  <Card title="Connect WooCommerce" icon="store" href="/docs/how-to/connect-woocommerce">
    One-click or REST API keys, store URL, and webhook setup.
  </Card>

  <Card title="Shopify settings" icon="shopping-bag" href="/docs/how-to/shopify-settings">
    Installation, order import, checkout rates, and shipping-method mapping.
  </Card>

  <Card title="Custom channel API" icon="webhook" href="/docs/how-to/custom-channel-api">
    Ingest URL, signing secret, and pushing orders from your own shop or ERP.
  </Card>

  <Card title="Order channel settings" icon="settings-2" href="/docs/how-to/order-channel-settings">
    Enable, disable, sync, orphaned channels, and remove a store.
  </Card>

  <Card title="Edit order lines" icon="list" href="/docs/how-to/edit-order-lines">
    SKU, quantity, price, origin, and tariff fields on an order or parcel.
  </Card>
</CardGroup>

## Carriers

<CardGroup cols={2}>
  <Card title="Carrier credentials" icon="key" href="/docs/how-to/carrier-credentials">
    Connect a carrier, required vs optional config, and edit-carrier toggles.
  </Card>

  <Card title="Sandbox mode" icon="flask-conical" href="/docs/how-to/sandbox-mode">
    Sandbox Mode checkbox on connect or edit — bookings hit that carrier’s test host.
  </Card>

  <Card title="Products and services" icon="package" href="/docs/how-to/carrier-products-and-services">
    Enable products, extra services, and additional parameters.
  </Card>

  <Card title="Request a carrier" icon="git-pull-request" href="/docs/how-to/request-carrier-integration">
    Submit a carrier integration request with sandbox credentials.
  </Card>

  <Card title="Droppoint vs service point" icon="map" href="/docs/how-to/drop-point-and-service-points">
    Why the UI uses both names and which screen shows which.
  </Card>

  <Card title="Carrier tracking webhooks" icon="radio" href="/docs/how-to/tracking-webhooks">
    Carrier tracking callbacks — not the app webhooks in Settings.
  </Card>
</CardGroup>

## Printing

<CardGroup cols={2}>
  <Card title="Set up the printer client" icon="monitor-down" href="/docs/how-to/setup-printer-client">
    Install Zippendo Printer, sign in with the browser, and register a local printer.
  </Card>

  <Card title="Add a printer" icon="printer" href="/docs/how-to/add-a-printer">
    Register, name, type (label vs document), and rotate-wide-pages.
  </Card>

  <Card title="Authorize the printer client" icon="shield-check" href="/docs/how-to/authorize-a-printer">
    Download the client, approve a pending printer, online vs offline.
  </Card>

  <Card title="Auto-print" icon="zap" href="/docs/how-to/auto-print">
    Auto-print labels and documents from a shipping rule or shipment.
  </Card>

  <Card title="Printer jobs" icon="list-todo" href="/docs/how-to/printer-jobs">
    Pending, Processing, Failed, and Completed jobs — retry, delete, and job detail.
  </Card>

  <Card title="Shipment printer settings" icon="settings" href="/docs/how-to/shipment-printer-settings">
    Label and document printer on a single shipment.
  </Card>
</CardGroup>

## Automation

<CardGroup cols={2}>
  <Card title="Automations" icon="workflow" href="/docs/how-to/automations">
    Builder, triggers, actions, conditions, runs, and test run.
  </Card>

  <Card title="Shipping rule fields" icon="sliders-horizontal" href="/docs/how-to/shipping-rule-fields">
    Conditions, weight/value bounds, countries, documents, returns, printers.
  </Card>

  <Card title="Schedule a pickup" icon="calendar-check" href="/docs/how-to/schedule-a-pickup">
    Book a carrier pickup: date, window, and instruction.
  </Card>
</CardGroup>

## Account and workspace

<CardGroup cols={2}>
  <Card title="Invite team members" icon="user-plus" href="/docs/how-to/invite-team-members">
    Email invite, optional role, pending vs active, revoke.
  </Card>

  <Card title="Roles and permissions" icon="shield" href="/docs/how-to/roles-and-permissions">
    Built-in roles, custom roles, and read/write scopes.
  </Card>

  <Card title="Create a brand" icon="tags" href="/docs/how-to/create-a-brand">
    Name, slug, invoice details, customs IDs, and brand document branding.
  </Card>

  <Card title="Organization settings" icon="building-2" href="/docs/how-to/organization-settings">
    Name, description, VOEC/EORI/IOSS and other customs identifiers.
  </Card>

  <Card title="Branding" icon="palette" href="/docs/how-to/branding">
    Organization logo and document colours (house-wide, not brand-specific).
  </Card>

  <Card title="Sender addresses" icon="map-pinned" href="/docs/how-to/sender-addresses">
    Mapbox search, sender/pickup/return types, and contact fields.
  </Card>

  <Card title="Billing and usage" icon="credit-card" href="/docs/how-to/billing-and-usage">
    Plans, usage meters, overage, Shopify-billed vs Stripe.
  </Card>

  <Card title="Danger zone" icon="triangle-alert" href="/docs/how-to/danger-zone">
    Delete organization or account — irreversible, export first.
  </Card>

  <Card title="Data export" icon="download" href="/docs/how-to/data-export">
    Request a full org archive (credentials never included).
  </Card>

  <Card title="Profile and security" icon="user-cog" href="/docs/how-to/profile-and-security">
    Email, language, two-factor authentication, leave organization.
  </Card>

  <Card title="Import from another platform" icon="upload" href="/docs/how-to/import-from-another-platform">
    Settings → Import wizard for carriers, rules, and setup.
  </Card>

  <Card title="Switch organization and brand" icon="arrow-left-right" href="/docs/how-to/switch-organization-and-brand">
    Team switcher: Manage, invite, switch org, scope to a brand.
  </Card>
</CardGroup>

## Search and dashboard

<CardGroup cols={2}>
  <Card title="Search and filters" icon="search" href="/docs/how-to/search-and-filters">
    List search, status/type/carrier/channel filters, and empty results.
  </Card>

  <Card title="Export dashboard CSV" icon="file-spreadsheet" href="/docs/how-to/dashboard-csv-export">
    Download the dashboard snapshot from the header **Export CSV** control.
  </Card>

  <Card title="Ask Zippy" icon="sparkles" href="/docs/how-to/zippy-ai">
    Header **Zippy** button (⌘J / Ctrl+J). `/dashboard/chat` is a stub — do not use it.
  </Card>
</CardGroup>

## API and events

<CardGroup cols={2}>
  <Card title="Create an API token" icon="key-round" href="/docs/how-to/create-an-api-token">
    Name, expiry, scopes — copy once; used by the public REST API.
  </Card>

  <Card title="Webhooks" icon="webhook" href="/docs/how-to/webhooks">
    App event webhooks in Settings (HMAC to your URL) — not carrier tracking.
  </Card>

  <Card title="Shipping quotes" icon="calculator" href="/docs/how-to/shipping-quotes">
    Public Shipping Quote API for checkout rates (Shopify/Woo use this).
  </Card>
</CardGroup>

## Naming that trips people up

* **Service point** vs **droppoint** — same pickup location, different labels. See [Droppoint vs service point](/docs/how-to/drop-point-and-service-points).
* **App webhooks** vs **carrier tracking webhooks** — [Webhooks](/docs/how-to/webhooks) vs [Carrier tracking webhooks](/docs/how-to/tracking-webhooks).
* **Data export** (org archive) vs **dashboard CSV** — [Data export](/docs/how-to/data-export) vs [Export dashboard CSV](/docs/how-to/dashboard-csv-export).
* **Zippy** vs **Chat** — the assistant is the header **Zippy** button (⌘J / Ctrl+J). `/dashboard/chat` is leftover placeholder copy (“Chat with support or your team”) and is not in the sidebar. [Ask Zippy](/docs/how-to/zippy-ai).
* **Labels** — `/dashboard/labels` is a stub (“Manage your shipping labels”). It is **not** in the sidebar. Print from a shipment’s **Documents** tab: [Labels and printing](/docs/tutorials/labels-printing).
* **Hold / Cancel** — there is no Hold or Cancel button on shipment detail, and no cancel-at-carrier control. [Hold, cancel, or delete](/docs/how-to/hold-cancel-and-delete-shipments).

<Info>
  Field copy on these pages must match the live client. If a control is missing from the app, it does not belong in the how-to. Author rules: `apps/docs/how-to/README.md`.
</Info>
