Workflow Overview
Step 1: Create Orders
When a customer places an order, create a parcel in CrossBorderly:Step 2: Print Labels
Download and print the shipping label:Step 3: Submit Manifest
Once you have a batch of parcels ready to ship, submit them as a manifest:Step 4: Track Parcels
Real-time via Webhooks (Recommended)
Configure webhooks to receive status updates automatically:Polling (Fallback)
For batch status checks:Step 5: Handle Exceptions
Build exception handling into your workflow:Best Practices
Batch Operations
Batch Operations
- Create orders in batches during off-peak hours
- Submit manifests when you have 50+ parcels ready
- Use batch tracking instead of individual calls
Error Recovery
Error Recovery
- Always use idempotency keys for POST requests
- Implement retry logic with exponential backoff
- Store raw API responses for troubleshooting
Performance
Performance
- Cache label URLs (valid for 24 hours)
- Use webhooks instead of polling when possible
- Parallelize non-dependent API calls
Complete Integration Checklist
1
Account Setup
- Get production API key
- Configure webhook URL
- Set up sandbox for testing
2
Order Integration
- Map your order data to CrossBorderly format
- Implement idempotency with order IDs
- Handle validation errors
3
Label Management
- Auto-download labels on order creation
- Implement reprint functionality
- Handle label format preferences (PDF/ZPL)
4
Manifest Workflow
- Batch parcels by destination country
- Submit manifests before carrier pickup
- Handle partial success responses
5
Tracking
- Configure webhook endpoints
- Map status codes to your system
- Build customer tracking page
6
Exception Handling
- Monitor for delivery exceptions
- Implement retry logic
- Set up alerts for operations team