fulfillment add
Add and configure fulfillment providers for automated order shipping.
Overview
The hyperfold fulfill add command connects your fulfillment providers to Hyperfold. Once configured, your Fulfillment Agent can automatically create shipping labels, track packages, and manage inventory across all connected warehouses.
Fulfillment providers are used by the Fulfillment Agent to process orders automatically after checkout completes.
Usage
bash
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
# Add a fulfillment provider$ hyperfold fulfill add shipstation Configuring ShipStation integration... Enter your ShipStation API Key: ********Enter your ShipStation API Secret: ******** Testing connection...✓ Connected to ShipStation PROVIDER CONFIGURED Provider: ShipStation Account: Acme Sports Warehouses: 3 detected Carriers: USPS, FedEx, UPS Would you like to import carrier rates? [Y/n] y✓ Carrier rates imported Fulfillment provider ready!Supported Providers
| Provider | Features | Docs |
|---|---|---|
| ShipStation | Multi-carrier, warehouse sync, batch labels | Setup Guide |
| Shippo | Rate comparison, tracking, returns | Setup Guide |
| Custom API | Any REST endpoint, webhook support | Data Mapping |
Options
| Option | Description |
|---|---|
--api-key | Provider API key (or prompted if not provided) |
--api-secret | Provider API secret (if required) |
--default-carrier | Preferred carrier for shipments |
--fallback-carriers | Comma-separated list of fallback carriers |
--name | Custom name for the provider (custom type) |
--endpoint | API endpoint URL (custom type) |
--webhook-url | URL for status updates from provider |
Examples
Add Shippo
bash
1
2
3
4
5
6
7
8
9
10
11
12
# Add Shippo as fulfillment provider$ hyperfold fulfill add shippo --api-key=shippo_live_xxx ✓ Connected to Shippo✓ Account: acme-sports-001✓ Default carriers configured # Add with specific carrier preferences$ hyperfold fulfill add shippo \ --api-key=shippo_live_xxx \ --default-carrier=usps \ --fallback-carriers=fedex,upsAdd Custom Provider
bash
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
# Add custom fulfillment endpoint$ hyperfold fulfill add custom \ --name="In-House Warehouse" \ --endpoint="https://warehouse.acme.com/api/fulfill" \ --auth-header="X-Warehouse-Key" \ --auth-value="wh_secret_xxx" Testing custom endpoint...✓ Endpoint responded successfully✓ Schema validated CUSTOM PROVIDER CONFIGURED Name: In-House Warehouse Endpoint: https://warehouse.acme.com/api/fulfill Status: active # Verify webhook setup$ hyperfold fulfill add custom \ --name="3PL Partner" \ --endpoint="https://3pl.example.com/api" \ --webhook-url="https://api.hyperfold.io/webhooks/fulfill/xyz"List and Verify Providers
bash
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
# List configured providers$ hyperfold fulfill list FULFILLMENT PROVIDERS PROVIDER TYPE WAREHOUSES STATUSShipStation integration 3 activeShippo integration 1 activeIn-House custom 2 active # Show provider details$ hyperfold fulfill show shipstation PROVIDER: ShipStation━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ Type: IntegrationConnected: 2025-01-15T10:00:00ZStatus: active WAREHOUSES 1. Los Angeles, CA (primary) 2. Chicago, IL (secondary) 3. New York, NY (secondary) CARRIERS ✓ USPS Priority $7.50 - $15.00 ✓ USPS First Class $3.50 - $8.00 ✓ FedEx Ground $9.00 - $18.00 ✓ FedEx Express $15.00 - $45.00 ✓ UPS Ground $8.50 - $17.00 PERFORMANCE (30 days) Orders Fulfilled: 2,847 Avg Ship Time: 1.2 days On-Time Rate: 98.4%After adding a provider, configure warehouse locations and fulfillment policies.