API Reference

The Shipi API v1 provides a modern RESTful interface for managing your entire shipping workflow programmatically — shipments, addresses, carriers, account info, and analytics. Use it to build custom integrations, dashboards, or AI-powered shipping assistants. Base URL All v1 endpoints live under the /api/v1/ path. The existing endpoints (Create Shipment, Get Rates, Track) remain at their original paths and […]

This page covers the remaining v1 API endpoints: Carrier Accounts, Account Info, Shipping Statistics, and Tracking URL. Authentication required for all endpoints except Tracking URL. See the API Overview for authentication details. Carrier Accounts List your configured shipping carrier accounts. This shows which carriers you have set up (FedEx, UPS, DHL, etc.) along with the shipper address configured for each account. Security […]

The Address Book API lets you manage saved shipper and receiver addresses. Save frequently used addresses and reuse them when creating shipments — no need to type the same address every time. Authentication required. All requests need your integration_key. See the API Overview for details. Endpoint Use the action parameter to specify the operation: list, get, add, edit, or delete. 1. List Addresses Get all saved addresses, optionally […]

The Create Shipment endpoint lets you push orders into Shipi and optionally generate shipping labels automatically. Use it to integrate multi-carrier shipping into any custom platform, ERP, or application. Base URL Authentication Every API request requires two credentials sent in the request body: The Create Shipment endpoint lets you push orders into Shipi and optionally generate shipping labels automatically. […]

The Track Shipment endpoint returns real-time tracking events for any shipment created through Shipi. Use it to build custom tracking pages, send status notifications, or display delivery updates in your application. Base URL Authentication No authentication required. The tracking endpoint is public — it looks up the shipment by tracking number and uses the stored carrier credentials to […]

The Get Shipping Rates endpoint returns real-time shipping rates from all your configured carriers for a given destination and package. Use it to show live rates at checkout or compare carrier pricing in your application. Base URL Authentication Every API request requires two credentials sent in the request body: Parameter Type Description shop_id string Your store’s integration […]