# Shiipp

## Docs

- [Shiipp API Authentication: Tokens, 2FA, and API Keys](https://docs.aeoral.com/api-reference/authentication.md): Obtain a JWT Bearer token via POST /api/login.php or use your X-API-KEY for the public Prealert endpoint. Includes 2FA flow and error codes.
- [Generate a Shiipp Courier Invoice for a Date Range](https://docs.aeoral.com/api-reference/billing/generate-invoice.md): POST /api/GenerateCourierInvoice.php — compute fees for all packages in a date range, apply weight tiers, and return a detailed invoice preview.
- [Load Shiipp Courier Billing History and Invoice List](https://docs.aeoral.com/api-reference/billing/load-bills.md): GET /api/LoadCourierBills.php — retrieve billing history with totals, tax, paid amounts, and invoice status. Courier role is scoped to own records.
- [Manage Your Shiipp Courier Profile, Logo, and Keys](https://docs.aeoral.com/api-reference/courier-settings/profile.md): GET and POST /api/CourierSettingsAPI.php — read and update your courier profile, upload your logo, and regenerate your API key for the prealert endpoint.
- [Configure Shiipp Courier Weight-Tier Billing Rates](https://docs.aeoral.com/api-reference/courier-settings/rates.md): GET and POST /api/GetCourierRates.php — read global and per-courier weight tier rates, save rate tables, copy defaults, and update air freight rates.
- [Paginate, Sort, and Filter Shiipp Customers via API](https://docs.aeoral.com/api-reference/customers/list.md): GET /api/ManageCustomers.php — retrieve a paginated, sortable list of customers with optional search, branch, and courier filtering. JWT token required.
- [Create, Update, and Delete Shiipp Customer Records](https://docs.aeoral.com/api-reference/customers/manage.md): POST, PUT, DELETE /api/ManageCustomers.php — create, update, and delete customer profiles with role-scoped access and duplicate user code prevention.
- [Search Shiipp Customers with Fuzzy and Exact Matching](https://docs.aeoral.com/api-reference/customers/search.md): GET /api/SearchCustomers.php — search customers by name, email, or user code. Supports basic LIKE search and advanced fuzzy matching with scoring.
- [Bulk Import Shiipp Customers from a CSV File Upload](https://docs.aeoral.com/api-reference/customers/upload.md): POST /api/UploadCustomers.php — upload a CSV to bulk-add or update customers via upsert on user_code. Columns: user_code, first_name, last_name, branch.
- [Create a New Shiipp Flight Manifest with Audit Trail](https://docs.aeoral.com/api-reference/manifests/create.md): POST /api/CreateManifest.php — create a new flight manifest container. Requires manifest:create permission. Returns manifest_id and manifest_number.
- [Get Shiipp Manifest Details, Statistics, and Packages](https://docs.aeoral.com/api-reference/manifests/get.md): GET /api/GetManifest.php?id={manifest_id} — retrieve manifest metadata, all linked packages, and aggregate stats including weight and courier breakdown.
- [Manage Shiipp Manifests: Status, Packages, Metadata](https://docs.aeoral.com/api-reference/manifests/manage.md): POST /api/ManageManifest.php — action-based endpoint to create manifests, update metadata, add/remove packages, and change dispatch status.
- [Shiipp REST API Reference: Overview and Quick Start](https://docs.aeoral.com/api-reference/overview.md): The Shiipp API is a RESTful HTTP API. All endpoints accept JSON bodies and return JSON. Learn base URLs, auth methods, and response formats.
- [Retrieve and Filter Warehouse Packages — Shiipp API](https://docs.aeoral.com/api-reference/packages/retrieve.md): POST /api/RetrievePackages.php — query, filter, and paginate packages by tracking number, customer, courier, or date range. Export results to CSV or XLSX.
- [Update Package Fields via the Shiipp Warehouse API](https://docs.aeoral.com/api-reference/packages/update.md): POST /api/UpdatePackage.php — update package fields like weight, tracking number, and customer assignment. After update, the package is marked for re-sync.
- [Manage Prealerts: List, Create, Update, and Delete](https://docs.aeoral.com/api-reference/prealerts/manage.md): GET, POST, PUT, and DELETE /api/ManagePrealerts.php — list, filter, create, update, and remove prealerts. JWT Bearer auth required.
- [Submit a Prealert: POST /api/Prealert.php Reference](https://docs.aeoral.com/api-reference/prealerts/submit.md): Submit an advance shipment notification to Shiipp before a package arrives. Authenticated with X-API-KEY. Returns a prealert_id on success.
- [Submit Pre-Alert](https://docs.aeoral.com/api-reference/prealerts/submit-prealert-mdx.md): Submit a shipment pre-alert.
- [Authenticate API Requests to Shiipp](https://docs.aeoral.com/authentication.md): Shiipp uses JWT Bearer tokens for dashboard API calls and API keys for courier partner endpoints. Learn how to obtain and use each credential type.
- [v1.0.0](https://docs.aeoral.com/changelog/v1.0.0.md): July 3, 2026
- [Flight Manifests: Grouping and Dispatching Packages](https://docs.aeoral.com/concepts/manifests.md): A manifest in Shiipp groups packages into a flight container. Learn manifest statuses, AWB numbers, and how status changes trigger courier notifications.
- [Package Tracking and Lifecycle Management in Shiipp](https://docs.aeoral.com/concepts/packages-and-tracking.md): Understand how Shiipp logs, tracks, and manages packages from warehouse intake through delivery, including tracking numbers, weights, and statuses.
- [Prealerts: Pre-Arrival Package Notifications in Shiipp](https://docs.aeoral.com/concepts/prealerts.md): Prealerts let courier partners notify Shiipp about incoming packages before warehouse arrival, enabling faster intake and automatic customer data prefill.
- [Understanding User Roles and Permissions in Shiipp](https://docs.aeoral.com/concepts/roles-and-permissions.md): Shiipp uses role-based access control. Learn what each role — admin, manager, warehouse, and courier — can see and do across the platform.
- [Find, Use, and Rotate Your Courier API Key in Shiipp](https://docs.aeoral.com/courier/api-keys.md): Your Shiipp API key authenticates prealert submissions. Learn where to find it, how to rotate it, and best practices for keeping it secure.
- [Customer List JSON Format and Sync Behavior in Shiipp](https://docs.aeoral.com/courier/customer-list-format.md): Shiipp automatically pulls your customer list every 8 hours from an endpoint you configure. Learn the required JSON format and field names.
- [Courier Integration Overview — Shiipp Partner Guide](https://docs.aeoral.com/courier/overview.md): Connect your courier platform to Shiipp to automate prealerts, sync customer records, and receive real-time package and manifest status webhooks.
- [Submitting Advance Shipment Prealerts to Shiipp API](https://docs.aeoral.com/courier/submitting-prealerts.md): Use the Shiipp Prealert API to notify the warehouse about incoming packages before they arrive, enabling faster processing and automatic customer matching.
- [Configure Webhook Payloads with the Payload Builder](https://docs.aeoral.com/courier/webhook-payload-builder.md): Use Shiipp's Payload Builder to customize outbound webhook JSON structure for package and manifest status events sent to your courier endpoints.
- [Shiipp FAQ: Login, Packages, Manifests, and Billing](https://docs.aeoral.com/faq/common-issues.md): Answers to the most common questions from Shiipp users — covering login, packages, prealerts, customer codes, manifests, and billing.
- [Troubleshoot Shiipp Customer Sync and Webhook Errors](https://docs.aeoral.com/faq/sync-errors.md): Diagnose and fix common errors with Shiipp's automatic customer sync and outbound webhook delivery, including HTTP errors and JSON format issues.
- [Generate and Manage Courier Billing in Shiipp](https://docs.aeoral.com/guides/billing-and-invoicing.md): Learn how Shiipp calculates package fees by weight tier, generates invoices for courier partners, and manages payment status and billing history.
- [Build and Dispatch Flight Manifests in Shiipp](https://docs.aeoral.com/guides/building-manifests.md): Learn how to create flight manifests, add packages, update AWB numbers, and change status to dispatch packages — with automatic courier notifications.
- [Manage Customer Records in Shiipp](https://docs.aeoral.com/guides/customer-management.md): Add, edit, search, and bulk-import customer records in Shiipp. Customers are linked to couriers and matched to packages by user code.
- [Log Incoming Packages at the Warehouse](https://docs.aeoral.com/guides/scanning-packages.md): Step-by-step guide for warehouse staff to scan, log, and assign incoming packages using Shiipp's intake interface and prealert prefill system.
- [Shiipp: Warehouse & Logistics Management Platform](https://docs.aeoral.com/introduction.md): Shiipp is a multi-tenant SaaS platform for freight forwarders and courier companies to manage packages, track shipments, build flight manifests, and automate billing.
- [Get Started with Shiipp in Minutes](https://docs.aeoral.com/quickstart.md): Learn how to log in, obtain your credentials, and make your first API call to Shiipp — the logistics and warehouse management platform.

## OpenAPI Specs

- [openapi](https://docs.aeoral.com/openapi.yaml)